Skip to content

Commit e007743

Browse files
jedel1043NucciTheBoss
authored andcommitted
docs: add documentation and contact links to charmcraft.yaml
Signed-off-by: José Julián Espina <julian.espina@canonical.com>
1 parent 6e790df commit e007743

4 files changed

Lines changed: 88 additions & 25 deletions

File tree

charms/cephfs-server-proxy/charmcraft.yaml

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,34 @@
1-
# Copyright 2024 Canonical Ltd.
1+
# Copyright 2024-2026 Canonical Ltd.
22
# See LICENSE file for licensing details.
33

44
name: cephfs-server-proxy
55
type: charm
66
title: CephFS Proxy
7-
summary: Charmed Ceph FS server for non-charmed Ceph storage appliances.
7+
summary: Charmed operator for proxying access to an uncharmed CephFS filesystem.
88
description: |
9-
Charmed Ceph FS server for non-charmed Ceph storage appliances.
9+
As part of Charmed HPC, this charm deploys and manages a CephFS server proxy
10+
that exposes non-charmed Ceph storage appliances as Charmed filesystems. It
11+
bridges external Ceph clusters by providing authentication and connection
12+
details, enabling Charmed HPC workloads to mount non-charmed CephFS shares.
1013
11-
Enable CephFS Client charms to mount non-charmed Ceph shares.
14+
This charm integrates with the filesystem-client charm to provide mount
15+
information for CephFS shares to workload charms.
16+
17+
See the following how-to in Charmed HPC's documentation for more information about
18+
how the cephfs-server-proxy charm is used in Charmed HPC:
19+
20+
- [How to deploy a shared filesystem](https://ubuntu.com/hpc/docs/latest/howto/deploy/deploy-shared-filesystem/#how-to-deploy-a-shared-filesystem)
21+
22+
For more information about Charmed HPC, view the
23+
[full documentation](https://ubuntu.com/hpc/docs/latest).
1224
links:
25+
contact: https://matrix.to/#/#hpc:ubuntu.com
26+
documentation: https://ubuntu.com/hpc/docs/latest
27+
website: https://ubuntu.com/hpc
1328
source:
14-
- https://github.com/canonical/filesystem-charms
29+
- https://github.com/canonical/filesystem-charms
1530
issues:
16-
- https://github.com/canonical/filesystem-charms/issues
31+
- https://github.com/canonical/filesystem-charms/issues
1732

1833
platforms:
1934
ubuntu@26.04:amd64:

charms/filesystem-client/charmcraft.yaml

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,36 @@
1-
# Copyright 2024-2025 Canonical Ltd.
1+
# Copyright 2024-2026 Canonical Ltd.
22
# See LICENSE file for licensing details.
33

44
name: filesystem-client
5-
65
type: charm
7-
86
title: Filesystem Client
7+
summary: Charmed operator for mounting filesystems on machine charms.
8+
description: |
9+
As part of Charmed HPC, this charm deploys and manages the filesystem client
10+
responsible for mounting shared filesystems on machine charms. It handles the
11+
mount lifecycle and exposes mount information to workload charms, providing
12+
applications with access to exported filesystems.
913
10-
summary: Mount filesystems on machine charms.
14+
This charm integrates with the cephfs-server-proxy, lustre-server,
15+
lustre-server-proxy, and nfs-server-proxy charms to mount shared filesystems,
16+
and with workload charms to expose those mounts in their machines.
1117
12-
description: |
13-
Mount filesystems on machine charms.
18+
See the following how-to in Charmed HPC's documentation for more information about
19+
how the filesystem-client charm is used in Charmed HPC:
20+
21+
- [How to deploy a shared filesystem](https://ubuntu.com/hpc/docs/latest/howto/deploy/deploy-shared-filesystem/#how-to-deploy-a-shared-filesystem)
22+
23+
For more information about Charmed HPC, view the
24+
[full documentation](https://ubuntu.com/hpc/docs/latest).
1425
15-
Enables access to exported filesystems.
26+
links:
27+
contact: https://matrix.to/#/#hpc:ubuntu.com
28+
documentation: https://ubuntu.com/hpc/docs/latest
29+
website: https://ubuntu.com/hpc
30+
source:
31+
- https://github.com/canonical/filesystem-charms
32+
issues:
33+
- https://github.com/canonical/filesystem-charms/issues
1634

1735
platforms:
1836
ubuntu@26.04:amd64:

charms/lustre-server-proxy/charmcraft.yaml

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,34 @@
1-
# Copyright 2025 Canonical Ltd.
1+
# Copyright 2025-2026 Canonical Ltd.
22
# See LICENSE file for licensing details.
33

44
name: lustre-server-proxy
55
type: charm
66
title: Lustre Server Proxy
7-
summary: Charmed Lustre server for non-charmed Lustre storage appliances.
7+
summary: Charmed operator for proxying access to an uncharmed Lustre filesystem.
88
description: |
9-
Charmed Lustre server for non-charmed Lustre storage appliances.
9+
As part of Charmed HPC, this charm deploys and manages a Lustre server proxy
10+
that exposes non-charmed Lustre storage appliances as Charmed filesystems. It
11+
bridges external Lustre clusters by providing connection details and filesystem
12+
information, enabling Charmed HPC workloads to mount non-charmed Lustre shares.
1013
11-
Enable Lustre Client charms to mount non-charmed Lustre shares.
14+
This charm integrates with the filesystem-client charm to provide mount
15+
information for Lustre shares to workload charms.
16+
17+
See the following how-to in Charmed HPC's documentation for more information about
18+
how the lustre-server-proxy charm is used in Charmed HPC:
19+
20+
- [How to deploy a shared filesystem](https://ubuntu.com/hpc/docs/latest/howto/deploy/deploy-shared-filesystem/#how-to-deploy-a-shared-filesystem)
21+
22+
For more information about Charmed HPC, view the
23+
[full documentation](https://ubuntu.com/hpc/docs/latest).
1224
links:
25+
contact: https://matrix.to/#/#hpc:ubuntu.com
26+
documentation: https://ubuntu.com/hpc/docs/latest
27+
website: https://ubuntu.com/hpc
1328
source:
14-
- https://github.com/canonical/filesystem-charms
29+
- https://github.com/canonical/filesystem-charms
1530
issues:
16-
- https://github.com/canonical/filesystem-charms/issues
31+
- https://github.com/canonical/filesystem-charms/issues
1732

1833
platforms:
1934
ubuntu@26.04:amd64:

charms/nfs-server-proxy/charmcraft.yaml

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,34 @@
1-
# Copyright 2023 Canonical Ltd.
1+
# Copyright 2023-2026 Canonical Ltd.
22
# See LICENSE file for licensing details.
33

44
name: nfs-server-proxy
55
type: charm
66
title: NFS Server Proxy
7-
summary: Charmed NFS server for non-charmed NFS storage appliances.
7+
summary: Charmed operator for proxying access to an uncharmed NFS filesystem.
88
description: |
9-
Charmed NFS server for non-charmed NFS storage appliances.
9+
As part of Charmed HPC, this charm deploys and manages an NFS server proxy
10+
that exposes non-charmed NFS storage appliances as Charmed filesystems. It
11+
bridges external NFS servers by providing connection details and export
12+
information, enabling Charmed HPC workloads to mount non-charmed NFS shares.
1013
11-
Enable NFS Client charms to mount non-charmed NFS shares.
14+
This charm integrates with the filesystem-client charm to provide mount
15+
information for NFS shares to workload charms.
16+
17+
See the following how-to in Charmed HPC's documentation for more information about
18+
how the nfs-server-proxy charm is used in Charmed HPC:
19+
20+
- [How to deploy a shared filesystem](https://ubuntu.com/hpc/docs/latest/howto/deploy/deploy-shared-filesystem/#how-to-deploy-a-shared-filesystem)
21+
22+
For more information about Charmed HPC, view the
23+
[full documentation](https://ubuntu.com/hpc/docs/latest).
1224
links:
25+
contact: https://matrix.to/#/#hpc:ubuntu.com
26+
documentation: https://ubuntu.com/hpc/docs/latest
27+
website: https://ubuntu.com/hpc
1328
source:
14-
- https://github.com/canonical/filesystem-charms
29+
- https://github.com/canonical/filesystem-charms
1530
issues:
16-
- https://github.com/canonical/filesystem-charms/issues
31+
- https://github.com/canonical/filesystem-charms/issues
1732

1833
platforms:
1934
ubuntu@26.04:amd64:

0 commit comments

Comments
 (0)