{"id":19901895,"url":"https://github.com/hyperledger/firefly-helm-charts","last_synced_at":"2025-03-01T07:16:14.949Z","repository":{"id":40401560,"uuid":"447379529","full_name":"hyperledger/firefly-helm-charts","owner":"hyperledger","description":"Firefly Helm Charts","archived":false,"fork":false,"pushed_at":"2024-10-07T09:33:59.000Z","size":1321,"stargazers_count":16,"open_issues_count":15,"forks_count":24,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-02-25T21:58:16.682Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/hyperledger/firefly-helm-charts","language":"Smarty","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperledger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-12T21:44:25.000Z","updated_at":"2024-10-07T09:34:03.000Z","dependencies_parsed_at":"2024-02-02T15:27:24.892Z","dependency_job_id":"6724f530-2b64-47d8-a09c-0f274eb1c8c7","html_url":"https://github.com/hyperledger/firefly-helm-charts","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-helm-charts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-helm-charts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-helm-charts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-helm-charts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperledger","download_url":"https://codeload.github.com/hyperledger/firefly-helm-charts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241329418,"owners_count":19944985,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T20:16:32.355Z","updated_at":"2025-03-01T07:16:14.926Z","avatar_url":"https://github.com/hyperledger.png","language":"Smarty","readme":"# Hyperledger FireFly Helm Charts\n\n\u003cimg src=\"https://github.com/hyperledger/firefly/raw/main/images/hyperledger_firefly_logo.png\" /\u003e\n\nThe official [Helm chart](https://helm.sh/) for [Hypeledger Firefly](https://hyperledger.github.io/firefly/) and its\nrelated connector microservices. See the [chart `README`](charts/firefly/README.md) for installation and\nconfiguration instructions.\n\n## Quick Start\n\nIf you want to run these charts locally on your own machine, you can run a single command to get a fully working stack, end-to-end:\n\n```\nmake stack\n```\n\nThis will create a pre-set environment with the following configuration:\n\n- Runs all containers in [kind](https://kind.sigs.k8s.io/)\n- Sets up a PostgreSQL DB in the K8s cluster\n- Creates a basic single node Besu blockchain also running in the K8s cluster\n- Sets up FireFly and all of its dependencies to use these services\n- Sets up an ERC-20 / ERC-721 Token Connector in this stack\n- Provides an optional script to enable multiparty mode after initial set up\n\nIf you wish to make changes to your stack you can modify `./charts/firefly/local-kind-values.yaml` and run:\n\n```\nhelm upgrade --install firefly ./charts/firefly -f ./charts/firefly/local-kind-values.yaml\n```\n\n### Enabling multiparty mode\n\nAfter you run the quickstart command above, you can also (optionally) enable Multiparty mode. This will enabled FireFly's advanced Messaging features. To enable that, you can run the shell script:\n\n```\n./hack/multiparty.sh\n```\n\nThis will deploy the multiparty contract, update the config file, and register the org/node for you automatically. If you need to upgrade the multiparty in the future, you can run this script again and it will deploy and configure a new contract. It will not re-run registration if the org/node are already registered.\n\n\u003e NOTE: If you have enabled multiparty mode and you wish to make changes by customizing your values file, be sure to include the multiparty values as well, otherwise they will be removed and your multiparty network will not work.\n\u003e\n\u003e ```\n\u003e helm upgrade --install firefly ./charts/firefly -f ./charts/firefly/local-kind-values.yaml -f ./hack/multiparty-values.yaml\n\u003e ```\n\n### Modifying configuration\n\nConfiguration of the stack for non-default options is possible using these charts, broadly there are 2 places to make changes. For Besu charts, the appropriate `values.yaml` files in the `values` directory allows for configuration of values such as the genesis block, and Besu-specific options. For FireFly related components the `values.yaml` file within the sub-directory for the chart (stored in `charts/`) contains the configuration for options.\n\nViewing the appropriate README for each microservice, will give information around the values and structure of the configuration in the `values.yaml` files. \n\n## Accessing the Helm Repo\n\nHelm's [experimental OCI registry support](https://helm.sh/docs/topics/registries/) is used for publishing and retrieving\nthe FireFly Helm chart, as a result one must log into [GHCR](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry)\nto download the chart:\n\n```shell\nexport HELM_EXPERIMENTAL_OCI=1\n\nhelm registry login ghcr.io\n```\n\n\u003e **NOTE**: you must use a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\n\u003e when authenticating to the GHCR registry as opposed to using your GitHub password.\n\n## Development\n\n### Prerequisites\n\n- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installing-with-a-package-manager) 0.11+\n- [helm](https://helm.sh/docs/intro/install/) 3.7+\n- [ct](https://github.com/helm/chart-testing#installation) 3.4+\n\n### Linting\n\nLint the chart using [`ct`](https://github.com/helm/chart-testing) and ensure it adheres to the project conventions:\n\n```shell\nmake lint\n```\n\n### Testing\n\nCreate a local Kubernetes cluster in Docker via [`kind`](https://kind.sigs.k8s.io/):\n\n```shell\nmake kind\n```\n\nThen install FireFly dependencies to the cluster (i.e. PostgreSQL, cert-manager, Prometheus):\n\n```shell\nmake deps\n```\n\nRun the E2E tests:\n\n```shell\nmake test\n```\n\nOr deploy the chart using your own customized `charts/firefly/local-values.yaml`:\n\n```shell\nmake deploy\n```\n\nIf you are unsure of what to initially put in your `charts/firefly/locall-values.yaml` file, we\nsuggest using the [Ethereum CI values](charts/firefly/ci/eth-values.yaml) as a starting point\nand reading the [chart configuration documentation](charts/firefly/README.md#configuration):\n\n```shell\nmake starter\n```\n\nIf you are developing with a Fabric blockchain see the [Fabric CI values](charts/firefly/ci/fab-values.yaml) and\n[additional chart documentation](charts/firefly/README.md#fabric).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Ffirefly-helm-charts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperledger%2Ffirefly-helm-charts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Ffirefly-helm-charts/lists"}