History

Alex Kavanagh e367acdb05 Updates for caracal testing support These updates, on the master branch, are to support testing the caracal packages and support of the charms for caracal. They do NOT lock the charms down, and don't change the testing branches to stable branches. Change-Id: I5d4f5b0feac8d0efd4967ec5b6884ecc817c9f6b		2024-02-24 19:54:05 +00:00
..
actions	Add initial charm code	2021-02-26 12:16:24 +02:00
files	21.04 libraries freeze for charms on master branch	2021-04-03 20:27:19 +01:00
lib	Use custom PPA with Magnum packages	2021-03-26 11:46:26 +02:00
reactive	Add unit_tests	2021-03-11 11:01:29 +02:00
templates	Add cluster-user-trust config option	2023-09-07 15:14:58 -03:00
tests	Updates for caracal testing support	2024-02-24 19:54:05 +00:00
LICENSE	Add initial charm code	2021-02-26 12:16:24 +02:00
README.md	Update README.md	2021-03-10 11:53:57 +02:00
actions.yaml	Add initial charm code	2021-02-26 12:16:24 +02:00
config.yaml	Add cluster-user-trust config option	2023-09-07 15:14:58 -03:00
icon.svg	Add initial charm code	2021-02-26 12:16:24 +02:00
layer.yaml	Fix repo string in layer.yaml	2021-03-26 13:45:02 +01:00
metadata.yaml	Updates for caracal testing support	2024-02-24 19:54:05 +00:00
test-requirements.txt	Fix charm for tox4 compatibility	2023-01-23 13:31:44 +00:00
tox.ini	Updates for caracal testing support	2024-02-24 19:54:05 +00:00
wheelhouse.txt	Drop setuptools pinning in wheelhouse.txt	2023-09-22 14:17:44 -04:00

README.md

Overview

This charm provides the Magnum service for an OpenStack Cloud.

OpenStack Ussuri or later is required.

Usage

Magnum and the Magnum charm relies on services from a fully functional OpenStack Cloud and expects to be able to consume images from glance, consume certificate secrets from Barbican (preferably utilizing a Vault backend) and spin up Kubernetes clusters with Heat. Magnum requires the existence of the other core OpenStack services deployed via Juju charms, specifically: mysql, rabbitmq-server, keystone and nova-cloud-controller. The following assumes these services have already been deployed.

Required configuration

After deployment of the cloud, the domain-setup action must be run to configure required domains, roles and users in the cloud for Magnum clusters.

juju run-action magnum/0 domain-setup

Magnum generates and maintains a certificate for each cluster so that it can also communicate securely with the cluster. As a result, it is necessary to store the certificates in a secure manner. Magnum provides the following methods for storing the certificates and this is configured in /etc/magnum/magnum.conf in the section [certificates] with the parameter cert_manager_type Valid values are : [barbican, x509keypair, local]

trustee-domain - Domain used for COE

trustee-admin - Domain admin for the trustee-domain

Deploy a Kubernetes cluster

When Magnum deploys a Kubernetes cluster, it uses parameters defined in the ClusterTemplate and specified on the cluster-create command, for example:

openstack coe cluster template create k8s-cluster-template \
                           --image fedora-coreos-latest \
                           --keypair testkey \
                           --external-network public \
                           --dns-nameserver 8.8.8.8 \
                           --flavor m1.small \
                           --docker-volume-size 5 \
                           --network-driver flannel \
                           --coe kubernetes

openstack coe cluster create k8s-cluster \
                      --cluster-template k8s-cluster-template \
                      --master-count 3 \
                      --node-count 8

Refer to the ClusterTemplate and Cluster sections for the full list of parameters.

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.

High availability

When more than one unit is deployed with the hacluster application the charm will bring up an HA active/active cluster.

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases the hacluster subordinate charm is used to provide the Corosync and Pacemaker backend HA functionality.

See Infrastructure high availability in the OpenStack Charms Deployment Guide for details.

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.