A Charmed Operator for Waltz

This is the repository for the Waltz charmed operator, also known as "charm". This can be deployed individually or as a bundle.

💡If you are evaluating Waltz, you should use the whole bundle instead of this single charm. You should only deploy this charmed operator by itself if you already have a PostgreSQL database.

💡 You can find more information about Charmed Operators and Charmed Waltz in the bundle repository.

Deploying this Charmed Operator

If you don’t have a Juju model, you can follow this guide until the point you have one. You can then deploy this single charmed operator (instead of the whole bundle) running:

juju deploy finos-waltz-k8s --channel=edge

Connecting to PostgreSQL

To connect to your already existing PostgreSQL database, you can run:

juju config finos-waltz-k8s db-host="<db-host>" db-port="<db-port>" db-name="<db-name>" db-username="<db-username>" db-password="<db-password>"

If you do not have an existing PostgreSQL database, you can deploy a PostgreSQL database charm and relate it to the FINOS Waltz charm:

juju deploy postgresql-k8s
juju relate postgresql-k8s:db finos-waltz-k8s:db

OCI Images

This charm requires the Waltz docker image: ghcr.io/finos/waltz.

FINOS Waltz Charm and Bundle release automation process

This repository is configured to automatically build and publish a new Charm revision after a Pull Request merges. The new charm revisions will be released on the latest/edge channel with the latest associated Waltz image revision. For more information, see here.

The waltz-juju-bundle repository has a GitHub action configured to check periodically if there is a new official Waltz release. If there is a new release, the GitHub action will do the following steps:

• upload the new Waltz image versions file into Charmhub.
• create a new release for the FINOS Waltz charm on the latest/edge and release-version/edge channels.
• create a new release-release-version branch in the waltz-juju-bundle repository.
• update the bundle.yaml file, having the Waltz charm use the release-version/edge channel and create a commit.
• upload the new bundle.yaml file into Charmhub on the release-version/edge track.

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.

Help and Support

Feel free to create an issue or submit a Pull Request to this repository in order to contribute; make sure to read the Waltz Contribution Guide first.

You can also use chat to the contributors to this Waltz integration via the FINOS Waltz Slack Channel.

Roadmap

TODO

Contributing

Visit Waltz Contribution Guide to learn how to contribute to Waltz.

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and the Developer Guide for developer guidance.

License

Copyright (c) 2021-present, Canonical

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0