openstack/sunbeam-charms
Code Issues Proposed changes
Files
main
sunbeam-charms/charms/manila-cephfs-k8s/README.md
Claudiu Belu 91192baa16 Adds the manila relation 
The relation will use the manila-backend interface. It will be used
to relate manila-k8s with various storage backends through charms.
The first such backend is CephFS.

Change-Id: I22df9eeaf4f0ca4277c8b3d249a37bef60bb40be
Signed-off-by: Claudiu Belu <cbelu@cloudbasesolutions.com>
2025-08-28 07:30:14 +00:00

2.7 KiB
Raw Permalink Blame History

manila-cephfs-k8s

Description

manila-cephfs-k8s is an operator to manage the Manila Share for CephFS services on a Kubernetes based environment. This operator will allow CEPHFS NFS Manila shares to be created (storage_protocol=NFS).

Usage

Deployment

manila-cephfs-k8s is deployed using command below:

juju deploy manila-cephfs-k8s manila-cephfs --trust

For instructions on how to build the charm and deploy / refresh it, check out the CONTRIBUTING.md.

Now connect the manila-cephfs operator to existing database, messaging, and keystone identity, and manila operators:

juju relate manila-mysql-router:database manila-cephfs:database
juju relate rabbitmq:amqp manila-cephfs:amqp
juju relate keystone:identity-credentials manila-cephfs:identity-credentials
juju relate manila-cephfs:ceph-nfs admin/openstack-machines.microceph-ceph-nfs
juju relate manila:manila manila-cephfs:manila

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.

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 manila-cephfs. If the charm is not deployed then see file actions.yaml.

Relations

manila-cephfs-k8s requires the following relations:

  • amqp: To connect to RabbitMQ.
  • ceph-nfs: To connect to the Ceph Cluster.
  • database: To connect to MySQL.
  • identity-credentials: To connect to Keystone.

The following relations are optional:

  • logging: To send logs to Loki.
  • tracing: To connect to a tracing backend.

The charm provides the following relation:

  • manila: To provide Manila with the NFS storage backend.

OCI Images

The charm by default uses follwoing images:

  • ghcr.io/canonical/manila-share:2025.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.