openstack/sunbeam-charms

History

Guillaume Boutry e911599abe Migrate to unified charmcraft.yaml Charmcraft 3 moves towards a single charmcraft.yaml, this is needed for 24.04 migration. Change-Id: I743712752aaf37bf68730b64bd6c147dfad370e2 Signed-off-by: Guillaume Boutry <guillaume.boutry@canonical.com>		2024-10-08 09:38:10 +02:00
..
src	[*] update charm entrypoints	2024-10-07 11:11:43 +02:00
tests/unit	Migrate to unified charmcraft.yaml	2024-10-08 09:38:10 +02:00
.sunbeam-build.yaml	Implement tracing	2024-07-31 11:57:32 +02:00
charmcraft.yaml	Migrate to unified charmcraft.yaml	2024-10-08 09:38:10 +02:00
CONTRIBUTING.md	Initial import	2023-05-01 16:40:01 +02:00
LICENSE	Initial import	2023-05-01 16:40:01 +02:00
README.md	Update for 2024.1	2024-04-18 23:21:03 +00:00
rebuild	Allow rebuild charms on modifying a rebuild file	2023-12-06 18:58:50 +01:00
requirements.txt	Remove upper contraints on pydantic	2024-08-27 14:06:38 +05:30

README.md

heat-k8s

Description

heat-k8s is an operator to manage the orchestration services heat api, heat api cfn and heat engine on a Kubernetes based environment.

Usage

Deployment

heat-k8s is deployed using below command:

juju deploy heat-k8s heat --trust

Now connect the heat operator to existing database, keystone identity, keystone ops and rabbitmq operators:

juju relate mysql:database heat:database
juju relate keystone:identity-service heat:identity-service
juju relate keystone:identity-ops heat:identity-ops
juju relate rabbitmq:amqp heat:amqp

heat-api-cfn is deployed as separate instance of charm using below command:

juju deploy heat-k8s heat-cfn --trust --config api_service=heat-api-cfn

Configuration

This section covers common and/or important configuration options. See file config.yaml for the full list of options, along with their descriptions and default values. See the Juju documentation for details on configuring applications.

`api_service`

The api_service option determines whether to act as heat-api service or heat-api-cfn service. Accepted values are heat-api or heat-api-service and defaults to heat-api.

Actions

This section covers Juju actions supported by the charm. Actions allow specific operations to be performed on a per-unit basis. To display action descriptions run juju actions heat. If the charm is not deployed then see file actions.yaml.

Relations

heat-k8s requires the following relations:

database: To connect to MySQL identity-service: To register endpoints in Keystone identity-ops: To create heat stack domain and users ingress-internal: To expose service on underlying internal network ingress-public: To expose service on public network amqp: To connect to Rabbitmq

OCI Images

The charm by default uses following images:

ghcr.io/canonical/heat-consolidated:2024.1

Contributing

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

Bugs

Please report bugs on Launchpad.