filesystem_info

Relevant links

  Submit a bug

  Specification archive

Help us improve this page

Most of this content can be collaboratively discussed and changed in the respective README file.

Contribute

Discuss this interface

Share your thoughts on this interface with the community on discourse

Join the discussion

Charms

Providing filesystem_info

Featured charms

How to test a charm

Requiring filesystem_info

Featured charms

How to test a charm

Developer documentation

Usage

This interface defines how a charm that exports a shared filesystem can expose the required mount information to a client charm that wants to mount the filesystem.

Direction

The filesystem_info interface implements a provider/requirer pattern. The Requirer is a charm that wishes to mount a shared filesystem, and the Provider is the charm exporting the mount information to do that.

endpoint

Requirer

Provider

Behavior

The exported endpoint from the Provider needs to adhere to a sublanguage of the URI grammar, which is specified by [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986

Provider

  • Is expected to adhere to both the defined grammar and the additional requirements specified here.
  • Is expected to export mount information for a valid and accessible shared filesystem.

Requirer

  • Is expected to be able to parse the exported endpoint from the provider according to the defined grammar.
  • Is expected to either have support for mounting the provider's exported filesystem, or gracefully handle when it cannot mount it.

Relation Data

Only the provider must export relation data.

[Pydantic Schema]

Last updated about 3 hours ago. Help us improve this page.