Skip to content
This repository has been archived by the owner on Feb 28, 2023. It is now read-only.

Commodore Component: Resource Locker Operator

License

Notifications You must be signed in to change notification settings

projectsyn/component-resource-locker

⚠️ Repo Archive Notice

As of Feb 14, 2023, this component will no longer be updated, since the upstream resource-locker-operator has been deprecated for a while now. See https://github.com/redhat-cop/resource-locker-operator#deprecation-notice for the deprecation notice for Resource Locker Operator.

We provide component patch-operator as a drop-in replacement for component resource-locker. Component patch-operator provides a transitional resource-locker.libjsonnet component library to facilitate gradually migrating components which create resource patches to use the new patch-operator.libsonnet library directly. See the migration how-to to learn more.

Commodore Component: Resource Locker Operator

This is a Commodore Component for Resource Locker Operator.

This repository is part of Project Syn. For documentation on Project Syn and this component, see https://syn.tools.

Documentation

The rendered documentation for this component is available on the Commodore Components Hub.

Documentation for this component is written using Asciidoc and Antora. It is located in the docs/ folder. The Divio documentation structure is used to organize its content.

Run the make docs-serve command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation.

After writing the documentation, please use the make docs-vale command and correct any warnings raised by the tool.

Contributing and license

This library is licensed under BSD-3-Clause. For information about how to contribute see CONTRIBUTING.