mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-07 00:48:01 +01:00
35 lines
1.1 KiB
Plaintext
35 lines
1.1 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * operators/operator_sdk/helm/osdk-hybrid-helm.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="osdk-hh-create-helm-api_{context}"]
|
|
= Creating a Helm API
|
|
|
|
Use the Operator SDK CLI to create a Helm API.
|
|
|
|
.Procedure
|
|
|
|
* Run the following command to create a Helm API with group `cache`, version `v1`, and kind `Memcached`:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ operator-sdk create api \
|
|
--plugins helm.sdk.operatorframework.io/v1 \
|
|
--group cache \
|
|
--version v1 \
|
|
--kind Memcached
|
|
----
|
|
|
|
[NOTE]
|
|
====
|
|
This procedure also configures your Operator project to watch the `Memcached` resource with API version `v1` and scaffolds a boilerplate Helm chart. Instead of creating the project from the boilerplate Helm chart scaffolded by the Operator SDK, you can alternatively use an existing chart from your local file system or remote chart repository.
|
|
|
|
For more details and examples for creating Helm API based on existing or new charts, run the following command:
|
|
|
|
[source,terminal]
|
|
----
|
|
$ operator-sdk create api --plugins helm.sdk.operatorframework.io/v1 --help
|
|
----
|
|
====
|