# ops-lib-manifests
## Rationale for this library
Most kubernetes projects deploy with manifest files which promote suggested deployment
parameters, but those manifests aren't consistent about which options are requirements
and which options are variable. In some cases the project's distribution uses different
means of indicating a need for replacement.
For example, the following reference from [vsphere-cloud-controller-manager](https://github.com/kubernetes/cloud-provider-vsphere/blob/master/releases/v1.23/vsphere-cloud-controller-manager.yaml#L11-L24)
gives the consumer of this yaml an indication there should be usernames and passwords set
in the Secret object.
```yaml
apiVersion: v1
kind: Secret
metadata:
name: vsphere-cloud-secret
labels:
vsphere-cpi-infra: secret
component: cloud-controller-manager
namespace: kube-system
# NOTE: this is just an example configuration, update with real values based on your environment
stringData:
10.0.0.1.username: "<ENTER_YOUR_VCENTER_USERNAME>"
10.0.0.1.password: "<ENTER_YOUR_VCENTER_PASSWORD>"
1.2.3.4.username: "<ENTER_YOUR_VCENTER_USERNAME>"
1.2.3.4.password: "<ENTER_YOUR_VCENTER_PASSWORD>"
```
Automation tools like a juju charm will need to read these yaml manifest files, manipulate
its content, and deploy those manifests when any of the **configurable** data is changed.
## Supporting Multiple Releases
Likewise, the projects which release reference manifest files, will also release versions
of manifests. It's possible for a charm to load all the supported manifest files into a
folder structure such the charm supports multiple releases. This library supports this
requirements by having the charm store upstream manifest files unchanged in a folder
structure like this:
```
<base_path>
├── version - a file containing the default version
├── manifests - a folder containing all the releases
│ ├── v1.1.10 - a folder matching a configurable version
│ │ ├── manifest-1.yaml - any file with a `.yaml` file type
│ │ └── manifest-2.yaml
│ ├── v1.1.11
│ │ ├── manifest-1.yaml
│ │ └── manifest-2.yaml
│ │ └── manifest-3.yaml
```
Key file-heirarchy requirements
-------------------------------
| | |
| --- | --- |
| **$base_path** | A single charm can support multiple manifest releases
| **version** | A text file indicating to the library which manifest version is the default when the 'release' config is unspecified |
| **manifests** | A folder containing the individual release manifest folders |
| **$release** | A folder containing the yaml files of the specific release |
## Sample Usage
Once your charm includes the above manifest file hierarchy, your charm will need to define the
mutations the library should make to the manifests.
```python
from ops.manifests import Collector, Manifests, ManifestLabel, ConfigRegistry
class ExampleApp(Manifests):
def __init__(self, charm, charm_config):
manipulations = [
ManifestLabel(self),
ConfigRegistry(self),
UpdateSecret(self),
]
super().__init__("example", charm.model, "upstream/example", manipulations)
self.charm_config = charm_config
@property
def config(self) -> Dict:
"""Returns config mapped from charm config and joined relations."""
config = dict(**self.charm_config)
for key, value in dict(**config).items():
if value == "" or value is None:
del config[key] # blank out keys not currently set to something
config["release"] = config.pop("example-release", None)
return config
def is_ready(self, obj, condition) -> bool:
"""Filter conditions by object and condition."""
if (
obj.kind == "Deployment" and
obj.name == "MyDeployment" and
condition.type == "Ignored"
):
return None # ignore this condition
return super().is_ready(obj, condition)
class ExampleCharm(CharmBase):
def __init__(self, *args):
super().__init__(*args)
# collection of ManifestImpls
self.collector = Collector(ExampleApp(self, self.config))
# Register actions callbacks
self.framework.observe(self.on.list_versions_action, self._list_versions)
# Register update status callbacks
self.framework.observe(self.on.update_status, self._update_status)
def _list_versions(self, event):
self.collector.list_versions(event)
def _update_status(self, _):
unready = self.collector.unready
if unready:
self.unit.status = WaitingStatus(", ".join(unready))
else:
self.unit.status = ActiveStatus("Ready")
self.unit.set_workload_version(self.collector.short_version)
self.app.status = ActiveStatus(self.collector.long_version)
```
## Manifests
This class provides the following functions:
1) Integration with lightkube to create/read/update/delete resources into the cluster
2) Provides a means to select a manifest release
3) Loads manifest files from a known file hierarchy specific to a release
4) Manipulates resource objects of a specific release
5) Provides comparisons between the installed resources and expected resources
6) Provides user listing of available releases
### Creating a Manifest Impl
It's expected that the developer create a `Manifest` impl -- a derived class -- that implements
one property -- `config`. This property provides some basic requirements to the
Manifest parent class and gives context for each custom `Manipulation` to act on
relation or config data.
```python
@property
def config(self) -> Dict:
"""Returns config mapped from charm config and joined relations."""
```
#### Expected `config` key mappings
* `release`
* optional `str` which identifies which release of the manifest to choose.
* defaults to `None` which will select the `default_release` if available.
* if `default_release` isn't found, the latest release is chosen.
* `image-registry`
* optional `str` which will be used by the `ConfigRegistry` manipulation
* defaults to `None` which uses the resources built-in registry location
* if specified, will replace the text up to the first `/` with its contents
### Cluster CRUD methods
* `status()`
* queries all in cluster resources associated with the current release which
has a `.status.conditions` attribute.
* `installed_resources()`
* queries all in cluster resources associated with the current release which
is installed.
* `labelled_resources()`
* queries all in cluster resources associated with the charm and manifest in general
which is installed.
* this can be compared with the `resources` property to look for extra resources
installed which are no longer necessary.
* `apply_manifests()`
* applies all resources from the current release into the cluster.
* resources are force applied, overwriting existing resources.
* `apply_resources(*resources)` and `apply_resource(...)`
* applies itemized resources into the cluster.
* resources are force applied, overwriting existing resources.
* `delete_manifests(...)`
* will delete all current release resources from the cluster
* see `delete_resources` for keyword arguments
* `delete_resources(...)`
* delete a specified set of resources from the cluster with options to
seamlessly handle certain failures.
* `delete_resource(...)`
* alias to `delete_resources` for when reading clarity demands only deleting
one resource.
## Collector
This class provides a native collection for operating collectively on
the manifests within a single charm. It provides methods for responding to
* action list-versions
* action scrub-resources
* action list-resources
* action apply-missing-resources
* querying the collective versions (short and long types)
* listing which resources have a non-active status
To integrate into an [ops charm](https://juju.is/docs/sdk/ops), for each
released application the charm manages, create a new `Manifests` impl,
and add an instance of it to a `Collector`.
```python
class AlternateApp(Manifests):
def __init__(self, charm, charm_config):
super().__init__("alternate", charm.model, "upstream/example")
self.charm_config = charm_config
@property
def config(self) -> Dict:
"""Returns config mapped from charm config and joined relations."""
config = dict(**self.charm_config)
for key, value in dict(**config).items():
if value == "" or value is None:
del config[key] # blank out keys not currently set to something
config["release"] = config.pop("alternate-release", None)
return config
class ExampleCharm(CharmBase):
def __init__(self, *args):
...
# collection of ManifestImpls
self.collector = Collector(
ExampleApp(self, self.config),
AlternateApp(self, self.config),
)
```
## Manipulations
### Patching a manifest resource
Some resources already exist within the manifest, and just need to be updated.
#### Built in Patchers
* `ManifestLabel`
* adds to each resource's `metadata.labels` the following:
1) `juju.io/application: manifests.app_name`
2) `juju.io/manifest: manifests.name`
3) `juju.io/manifest-version: <manifests.name>-<version>`
* `ConfigRegistry`
* updates the image registry of every `Pod`, `DaemonSet`, `Deployment`, and
`StatefulSet` from the `image-registry` config item in the config
properties `Dict`.
* If the charm doesn't wish to alter the config, ensure nothing exists
in the `image-registry`.
* `update_toleration`
* not officially a patcher, but can be used by a custom Patcher
to adjust tolerations on `Pod`, `DaemonSet`, `Deployment`, and `StatefulSet`
resources.
### Adding a manifest resource
Some resources do not exist in the release manifest and must be added. The `Addition` manipulations are added
before the rest of the `Patch` manipulations are applied.
#### Built in Adders
* `CreateNamespace` - Creates a namespace resource using either the manifest's default namespace or
an argument passed in to the constructor of this class.
### Subtracting a manifest resource
Some manifest resources are not needed and must be removed. The `Subtraction` manipulations are added
before the rest of the `Patch` manipulations are applied.
#### Built in Subtractors
* `SubtractEq` - Subtracts a manifest resource equal to the resource passed in as an argument. Resources are considered
equal if they have the same kind, name, and namespace.
### Custom Manipulations
Of course the built-ins will not be enough, so your charm may extend its own manipulations by defining
new objects which inherit from either `Patch` or `Addition`.
Raw data
{
"_id": null,
"home_page": null,
"name": "ops.manifest",
"maintainer": null,
"docs_url": null,
"requires_python": ">3.8",
"maintainer_email": null,
"keywords": "juju, charming, kubernetes, operators, manifests, yaml",
"author": null,
"author_email": "Adam Dyess <adam.dyess@canonical.com>",
"download_url": "https://files.pythonhosted.org/packages/d3/bc/f68f07d43f33bdc8a65da60c03a634d3d0c24f0318578c81f10d90f950a3/ops_manifest-1.5.0.tar.gz",
"platform": null,
"description": "# ops-lib-manifests\n\n## Rationale for this library\nMost kubernetes projects deploy with manifest files which promote suggested deployment\nparameters, but those manifests aren't consistent about which options are requirements\nand which options are variable. In some cases the project's distribution uses different\nmeans of indicating a need for replacement.\n\nFor example, the following reference from [vsphere-cloud-controller-manager](https://github.com/kubernetes/cloud-provider-vsphere/blob/master/releases/v1.23/vsphere-cloud-controller-manager.yaml#L11-L24)\ngives the consumer of this yaml an indication there should be usernames and passwords set\nin the Secret object.\n\n```yaml\napiVersion: v1\nkind: Secret\nmetadata:\n name: vsphere-cloud-secret\n labels:\n vsphere-cpi-infra: secret\n component: cloud-controller-manager\n namespace: kube-system\n # NOTE: this is just an example configuration, update with real values based on your environment\nstringData:\n 10.0.0.1.username: \"<ENTER_YOUR_VCENTER_USERNAME>\"\n 10.0.0.1.password: \"<ENTER_YOUR_VCENTER_PASSWORD>\"\n 1.2.3.4.username: \"<ENTER_YOUR_VCENTER_USERNAME>\"\n 1.2.3.4.password: \"<ENTER_YOUR_VCENTER_PASSWORD>\"\n```\n\nAutomation tools like a juju charm will need to read these yaml manifest files, manipulate\nits content, and deploy those manifests when any of the **configurable** data is changed.\n\n\n## Supporting Multiple Releases\nLikewise, the projects which release reference manifest files, will also release versions\nof manifests. It's possible for a charm to load all the supported manifest files into a \nfolder structure such the charm supports multiple releases. This library supports this \nrequirements by having the charm store upstream manifest files unchanged in a folder \nstructure like this:\n\n```\n<base_path>\n\u251c\u2500\u2500 version - a file containing the default version\n\u251c\u2500\u2500 manifests - a folder containing all the releases\n\u2502 \u251c\u2500\u2500 v1.1.10 - a folder matching a configurable version\n\u2502 \u2502 \u251c\u2500\u2500 manifest-1.yaml - any file with a `.yaml` file type\n\u2502 \u2502 \u2514\u2500\u2500 manifest-2.yaml\n\u2502 \u251c\u2500\u2500 v1.1.11\n\u2502 \u2502 \u251c\u2500\u2500 manifest-1.yaml\n\u2502 \u2502 \u2514\u2500\u2500 manifest-2.yaml\n\u2502 \u2502 \u2514\u2500\u2500 manifest-3.yaml\n```\n\nKey file-heirarchy requirements\n-------------------------------\n| | |\n| --- | --- |\n| **$base_path** | A single charm can support multiple manifest releases\n| **version** | A text file indicating to the library which manifest version is the default when the 'release' config is unspecified |\n| **manifests** | A folder containing the individual release manifest folders |\n| **$release** | A folder containing the yaml files of the specific release |\n\n## Sample Usage\n\nOnce your charm includes the above manifest file hierarchy, your charm will need to define the\nmutations the library should make to the manifests. \n\n```python\nfrom ops.manifests import Collector, Manifests, ManifestLabel, ConfigRegistry\n\nclass ExampleApp(Manifests):\n def __init__(self, charm, charm_config):\n manipulations = [\n ManifestLabel(self),\n ConfigRegistry(self),\n UpdateSecret(self),\n ]\n super().__init__(\"example\", charm.model, \"upstream/example\", manipulations)\n self.charm_config = charm_config\n\n @property\n def config(self) -> Dict:\n \"\"\"Returns config mapped from charm config and joined relations.\"\"\"\n config = dict(**self.charm_config)\n\n for key, value in dict(**config).items():\n if value == \"\" or value is None:\n del config[key] # blank out keys not currently set to something\n\n config[\"release\"] = config.pop(\"example-release\", None)\n return config\n\n def is_ready(self, obj, condition) -> bool:\n \"\"\"Filter conditions by object and condition.\"\"\"\n if (\n obj.kind == \"Deployment\" and\n obj.name == \"MyDeployment\" and\n condition.type == \"Ignored\"\n ):\n return None # ignore this condition\n return super().is_ready(obj, condition)\n\n\nclass ExampleCharm(CharmBase):\n def __init__(self, *args):\n super().__init__(*args)\n\n # collection of ManifestImpls\n self.collector = Collector(ExampleApp(self, self.config))\n\n # Register actions callbacks\n self.framework.observe(self.on.list_versions_action, self._list_versions)\n \n # Register update status callbacks\n self.framework.observe(self.on.update_status, self._update_status)\n \n def _list_versions(self, event):\n self.collector.list_versions(event)\n\n def _update_status(self, _):\n unready = self.collector.unready\n if unready:\n self.unit.status = WaitingStatus(\", \".join(unready))\n else:\n self.unit.status = ActiveStatus(\"Ready\")\n self.unit.set_workload_version(self.collector.short_version)\n self.app.status = ActiveStatus(self.collector.long_version)\n \n```\n\n## Manifests\n\nThis class provides the following functions:\n1) Integration with lightkube to create/read/update/delete resources into the cluster\n2) Provides a means to select a manifest release\n3) Loads manifest files from a known file hierarchy specific to a release\n4) Manipulates resource objects of a specific release\n5) Provides comparisons between the installed resources and expected resources\n6) Provides user listing of available releases\n\n### Creating a Manifest Impl\nIt's expected that the developer create a `Manifest` impl -- a derived class -- that implements\none property -- `config`. This property provides some basic requirements to the\nManifest parent class and gives context for each custom `Manipulation` to act on \nrelation or config data.\n\n```python\n @property\n def config(self) -> Dict:\n \"\"\"Returns config mapped from charm config and joined relations.\"\"\"\n```\n\n#### Expected `config` key mappings\n* `release` \n * optional `str` which identifies which release of the manifest to choose.\n * defaults to `None` which will select the `default_release` if available.\n * if `default_release` isn't found, the latest release is chosen.\n* `image-registry`\n * optional `str` which will be used by the `ConfigRegistry` manipulation\n * defaults to `None` which uses the resources built-in registry location\n * if specified, will replace the text up to the first `/` with its contents\n\n\n### Cluster CRUD methods\n* `status()` \n * queries all in cluster resources associated with the current release which\n has a `.status.conditions` attribute.\n* `installed_resources()`\n * queries all in cluster resources associated with the current release which \n is installed.\n* `labelled_resources()`\n * queries all in cluster resources associated with the charm and manifest in general\n which is installed.\n * this can be compared with the `resources` property to look for extra resources \n installed which are no longer necessary.\n* `apply_manifests()`\n * applies all resources from the current release into the cluster.\n * resources are force applied, overwriting existing resources.\n* `apply_resources(*resources)` and `apply_resource(...)`\n * applies itemized resources into the cluster.\n * resources are force applied, overwriting existing resources.\n* `delete_manifests(...)`\n * will delete all current release resources from the cluster\n * see `delete_resources` for keyword arguments\n* `delete_resources(...)`\n * delete a specified set of resources from the cluster with options to \n seamlessly handle certain failures.\n* `delete_resource(...)`\n * alias to `delete_resources` for when reading clarity demands only deleting\n one resource.\n\n## Collector\n\nThis class provides a native collection for operating collectively on\nthe manifests within a single charm. It provides methods for responding to \n* action list-versions\n* action scrub-resources\n* action list-resources\n* action apply-missing-resources\n* querying the collective versions (short and long types)\n* listing which resources have a non-active status\n\nTo integrate into an [ops charm](https://juju.is/docs/sdk/ops), for each \nreleased application the charm manages, create a new `Manifests` impl, \nand add an instance of it to a `Collector`.\n\n```python\nclass AlternateApp(Manifests):\n def __init__(self, charm, charm_config):\n super().__init__(\"alternate\", charm.model, \"upstream/example\")\n self.charm_config = charm_config\n\n\n @property\n def config(self) -> Dict:\n \"\"\"Returns config mapped from charm config and joined relations.\"\"\"\n config = dict(**self.charm_config)\n\n for key, value in dict(**config).items():\n if value == \"\" or value is None:\n del config[key] # blank out keys not currently set to something\n\n config[\"release\"] = config.pop(\"alternate-release\", None)\n return config\n\n\nclass ExampleCharm(CharmBase):\n def __init__(self, *args):\n ...\n # collection of ManifestImpls\n self.collector = Collector(\n ExampleApp(self, self.config), \n AlternateApp(self, self.config),\n )\n```\n\n\n## Manipulations\n\n### Patching a manifest resource\nSome resources already exist within the manifest, and just need to be updated.\n\n#### Built in Patchers\n* `ManifestLabel` \n * adds to each resource's `metadata.labels` the following:\n 1) `juju.io/application: manifests.app_name`\n 2) `juju.io/manifest: manifests.name`\n 3) `juju.io/manifest-version: <manifests.name>-<version>`\n\n* `ConfigRegistry`\n * updates the image registry of every `Pod`, `DaemonSet`, `Deployment`, and\n `StatefulSet` from the `image-registry` config item in the config\n properties `Dict`.\n * If the charm doesn't wish to alter the config, ensure nothing exists\n in the `image-registry`.\n\n* `update_toleration` \n * not officially a patcher, but can be used by a custom Patcher\n to adjust tolerations on `Pod`, `DaemonSet`, `Deployment`, and `StatefulSet`\n resources.\n\n### Adding a manifest resource\nSome resources do not exist in the release manifest and must be added. The `Addition` manipulations are added\nbefore the rest of the `Patch` manipulations are applied.\n\n#### Built in Adders\n* `CreateNamespace` - Creates a namespace resource using either the manifest's default namespace or \n an argument passed in to the constructor of this class. \n\n### Subtracting a manifest resource\nSome manifest resources are not needed and must be removed. The `Subtraction` manipulations are added\nbefore the rest of the `Patch` manipulations are applied.\n\n#### Built in Subtractors\n* `SubtractEq` - Subtracts a manifest resource equal to the resource passed in as an argument. Resources are considered \n equal if they have the same kind, name, and namespace.\n\n### Custom Manipulations\nOf course the built-ins will not be enough, so your charm may extend its own manipulations by defining\nnew objects which inherit from either `Patch` or `Addition`.\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "Kubernetes manifests for Operators",
"version": "1.5.0",
"project_urls": {
"BugTracker": "https://github.com/canonical/ops-lib-manifest/issues",
"Repository": "https://github.com/canonical/ops-lib-manifest"
},
"split_keywords": [
"juju",
" charming",
" kubernetes",
" operators",
" manifests",
" yaml"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ce65a71e456a19bff349702cf7e71a38bdc74b9c0d7db4daddf30e6f96479775",
"md5": "2b549a0eb61ecf577423012266d60f37",
"sha256": "90c913b4f868e72df32128c2ee7f75928b90f97e9ee1c758cd57f9fdff40a262"
},
"downloads": -1,
"filename": "ops.manifest-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b549a0eb61ecf577423012266d60f37",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.8",
"size": 19401,
"upload_time": "2025-02-11T17:10:28",
"upload_time_iso_8601": "2025-02-11T17:10:28.238335Z",
"url": "https://files.pythonhosted.org/packages/ce/65/a71e456a19bff349702cf7e71a38bdc74b9c0d7db4daddf30e6f96479775/ops.manifest-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d3bcf68f07d43f33bdc8a65da60c03a634d3d0c24f0318578c81f10d90f950a3",
"md5": "046d6bcedcd7129681a2171b6138cd25",
"sha256": "5cd93e6327541b6ae3a968c86eb1bd9d5ab0629c020343cbd085a69805f5c274"
},
"downloads": -1,
"filename": "ops_manifest-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "046d6bcedcd7129681a2171b6138cd25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.8",
"size": 20879,
"upload_time": "2025-02-11T17:10:31",
"upload_time_iso_8601": "2025-02-11T17:10:31.121080Z",
"url": "https://files.pythonhosted.org/packages/d3/bc/f68f07d43f33bdc8a65da60c03a634d3d0c24f0318578c81f10d90f950a3/ops_manifest-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-11 17:10:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "canonical",
"github_project": "ops-lib-manifest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ops.manifest"
}
JSON
