The Legend Charm Bundle provides a simple, efficient and enterprise-ready way to deploy and orchestrate a Legend instance in any type of environments, from developers workstations, up to production. The bundle includes several Charms, one for each Legend component.
Read more about Juju and Charms, access tutorials to deploy locally or in the cloud of your choice in minutes, and how you could support this initiative.
The Juju Charmed Operator Lifecycle Manager (OLM) is a hybrid-cloud application management and orchestration system for installation and day 2 operations. It helps deploy, configure, scale, integrate, maintain, and manage Kubernetes native, container-native and VM-native applications and the relations between them.
A charmed operator (also known, more simply, as a “charm”) encapsulates a single application and all the code and know-how it takes to operate it, such as how to combine and work with other related applications or how to upgrade it. Charms are programmed to understand a single application, its operations, and its potential to communicate or integrate with other applications. A charm defines and enables the channels by which applications connect.
The instructions cover the deployment of FINOS Legend charmed operators on a host PC along with a locally deployed Gitlab instance. However these charms can be deployed on any cloud and should be able to use any Gitlab instance with requisite permissions.
The Legend applications stack was deployed as a bundle in the same cloud. Juju allows, however, for you to deploy each application on a different cloud and then integrate the stack across your estate.
We assume your host had a functioning Internet connection. However it is also possible to deploy charmed operators offline.
This repository hosts the following tutorials to get started with Legend Charm from the ground up:
- The local run documention guides you through the entire setup to run Legend in your local workstation, using microk8s; the documentation was tested on Ubuntu and MacOS workstations, but it should work on Windows workstations too
- The AWS EKS documentation explains how to run Legend on a AWS EKS cluster from scratch.
If you'd like to see the cloud of your choice in this list, do not hesitate to create an issue
The Legend Charm Bundle is composed by several charms, which are hosted in multiple github repositories (see below).
Bundles and charms can be released through 2 different channels: latest/stable and latest/edge; the stable bundle will use stable charm versions, and similarly edge bundles will use edge charm versions.
Both latest bundle and charm versions are aligned with the latest Legend release version,as specified by the manifest.json files included in Legend releases.
Bundles and charms using the previous Legend releases can be deployed from their respective channels based on the official Legend releases(newer than 2022-04-01). For example, to deploy the 2022-04-05release of Juju, the channel2022-04/edge`` can be used.
Visit https://charmhub.io/finos-legend-bundle to know more about Legend Bundle versions available.
The repositories for each charm in the Legend bundle have been configured to build and publish a new charm revision whenever a new Pull Request merges on their respective repositories through GitHub actions. These charm revisions will also be released on the latest/edge channel with the latest associated Legend image revision.
The legend-juju-bundle repository has a GitHub action configured to check periodically if there is a new official Legend release. If there is a new release, the GitHub action will do the following steps:
- upload the Legend image versions specified in that release's
manifest.jsonfile into Charmhub. - create a new release for the Legend Engine, SDLC, and Studio charms on the
latest/edgeandyyyy-mm/edgechannels (whereyyyy-mmis the year and month of the Legend release). - create a new
release-yyyy-mm-ddbranch in the legend-juju-bundle repository. - update the
bundle.yamlfile, having the Legend Engine, SDLC, and Studio charms use theyyyy-mm/edgechannels and create a commit. - upload the new
bundle.yamlfile into Charmhub on theyyyy-mm/edgetrack.
Each repository has included in its README.md file and docs information about how their GitHub actions have been configured and what repositories secrets they require. In summary, they all require a Charmhub authentication token that has the permission to upload resources for the respective charms.
The Juju acceptance environment has been deployed on EKS using the EKS deployment guide. This repository has been configured with a GitHub action that will update the Legend Engine, SDLC and Studio charms of the Staging environment to their latest revisions (and thus, latest image versions).
For more information on how the GitHub action has been set up, as well as other actions currently running for the EKS environment, see here.
You can browse all repositories related with the Legend Juju Bundle via https://github.com/topics/legend-juju
Feel free to create an issue or submit a Pull Request to this repository in order to contribute; make sure to read the Legend Contribution Guide first.
You can also use chat to the contributors to this Legend integration via the FINOS Legend Slack Channel or the Canonical Mattermost channel.
Visit our roadmap to know more about the upcoming features.
Visit Legend Contribution Guide to learn how to contribute to Legend on Juju.
Copyright (c) 2021-present, Canonical
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0