Skip to content

Fixed CSV deployments label field doc #2198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/design/building-your-csv.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ Ensure that the `serviceAccountName` used in the `deployment` spec matches one o

Multiple Roles should be described to reduce the scope of any actions needed containers that the Operator may run on the cluster. For example, if you have a component that generates a TLS Secret upon start up, a Role that allows `create` but not `list` on Secrets is more secure than using a single all-powerful Service Account.

It is also possible to set custom labels for Deployment in addition to the system labels set by the OLM. This labels should be present in the `labels` fields of the `deployments` section.
It is also possible to set custom labels for Deployment in addition to the system labels set by the OLM. This labels should be present in the `label` fields of the `deployments` section.

Here’s a full example:

Expand All @@ -323,7 +323,7 @@ Here’s a full example:
spec:
deployments:
- name: example-operator
labels:
label:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

$ oc explain clusterserviceversions.spec.install.spec.deployments
KIND:     ClusterServiceVersion
VERSION:  operators.coreos.com/v1alpha1

RESOURCE: deployments <[]Object>

DESCRIPTION:

     StrategyDeploymentSpec contains the name, spec and labels for the
     deployment ALM should create

FIELDS:
   label	<map[string]string>
     Set is a map of label:value. It implements Labels.

   name	<string> -required-

   spec	<Object> -required-
     DeploymentSpec is the specification of the desired behavior of the
     Deployment.

application: example-operator
technology: general
spec:
Expand Down