Skip to content

Commit 9b79a95

Browse files
authored
Update operand-deployment-lifecycle-manager.v1.1.0.clusterservicevers… (#277)
* Update operand-deployment-lifecycle-manager.v1.1.0.clusterserviceversion.yaml * Update operand-deployment-lifecycle-manager.v1.1.0.clusterserviceversion.yaml
1 parent b3cebc9 commit 9b79a95

File tree

1 file changed

+34
-38
lines changed

1 file changed

+34
-38
lines changed

deploy/olm-catalog/operand-deployment-lifecycle-manager/1.1.0/operand-deployment-lifecycle-manager.v1.1.0.clusterserviceversion.yaml

Lines changed: 34 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -365,8 +365,8 @@ metadata:
365365
certified: "false"
366366
containerImage: quay.io/opencloudio/odlm:latest
367367
createdAt: "2020-03-26T11:05:16Z"
368-
description: The Operand Deployment Lifecycle Manager provides a Kubernetes CRD-Based
369-
API to manage the lifecycle of IBM cloud common services.
368+
description: The Operand Deployment Lifecycle Manager provides a Kubernetes CRD-based
369+
API to manage the lifecycle of IBM Cloud Platform common services.
370370
repository: https://github.com/IBM/operand-deployment-lifecycle-manager
371371
support: IBM
372372
name: operand-deployment-lifecycle-manager.v1.1.0
@@ -425,21 +425,18 @@ spec:
425425
x-descriptors:
426426
- urn:alm:descriptor:io.kubernetes.phase
427427
version: v1alpha1
428-
description: "Operand is the instance managed by the operator. ODLM is used to manage
429-
the lifecycle of for a group of operands, compared with operator lifecycle manager,
430-
ODLM focus on the management of operands but not operators.\n\n1. A single entrypoint
431-
to manage a group of operands\n1. User can select a set of operands to install\n1.
432-
The install can be invoked through either OCP UI or CLI\n\n# Use ODLM to manage
433-
Operators and Operands\n\nThe ODLM will have Three CRDs:\n\n* OperandRegistry,
434-
defines the individual operand deployment info\n* OperandConfigs, defines the
435-
individual operand deployment config\n* OperandRequests, defines which operator/operand
436-
want to be installed in the cluster\n\n**NOTE:** The ODLM managed operator subscriptions
437-
will have a label **\"operator.ibm.com/opreq-control\": \"true\"**, we use this
428+
description: "Operand is the instance that is managed by the operator. Operand Deployment Lifecycle Manager (ODLM) is used to manage the lifecycle of a group of operands. Compared with operator lifecycle manager (OLM), ODLM focuses on the management of operands but not the operators. \n\n - A single entrypoint
429+
to manage a group of operands\n - User can select a set of operands to install\n
430+
- The install can be invoked either through the OCP UI or CLI\n\n# Use ODLM to manage
431+
Operators and Operands\n\nThe ODLM has three CRDs:\n\n* **OperandRegistry** that
432+
defines the individual operand deployment info.\n* **OperandConfigs** that defines the
433+
individual operand deployment config\n* **OperandRequests** that defines which operator/operand
434+
you want to install in the cluster\n\n**NOTE:** The ODLM-managed operator subscriptions have a label **\"operator.ibm.com/opreq-control\": \"true\"**. We use this
438435
label to distinguish if an operator is managed by ODLM or not.\n\n## OperandRegistry\n\nOperandRegistry
439-
defines the individual dervice state. For example, an individual service should
440-
be present or absent.\n\n**NOTE:** When ODLM operator is deployed, it will generate
441-
a default OperandRegistry instance. You can edit it by your requirement. \n\nAn
442-
example of the OperandRegistry CR is shown below. The \"name\" parameter must
436+
defines the individual service state. For example, an individual service should
437+
be present or absent.\n\n**NOTE:** When the ODLM operator is deployed, it generates
438+
a default OperandRegistry instance. You can edit the instance as required. \n\nFollowing is an
439+
example of the OperandRegistry CR: \n\n **NOTE:**The \"name\" parameter must
443440
be unique for each entry.\n\n```yaml\napiVersion: odlm.ibm.com/v1alpha1\nkind:
444441
OperandRegistry\nmetadata:\n name: common-service [1]\n namespace: ibm-common-services
445442
[2]\nspec:\n operators:\n - name: ibm-metering-operator [3]\n namespace:
@@ -448,33 +445,32 @@ spec:
448445
[8]\n description: The service used to meter workloads in a kubernetes cluster
449446
[9]\n```\n\nThe Operand (Deployment) Registry Custom Resource (CR) lists OLM Operator
450447
information for operands that may be requested for installation and/or access
451-
by an application running in a namespace. The registry CR specifies:\n\n1. Name
448+
by an application that runs in a namespace. The registry CR specifies:\n\n1. Name
452449
of the OperandRegistry\n1. Namespace of the OperandRegistry\n1. **name** is the
453450
name of the operator, which should be the same as the services name in the OperandConfig
454-
and OperandRequest.\n1. **namespace** is the namespace the operator will be deployed
455-
in.\n1. **channel** is the name of OLM channel should be subscribed for the operator.\n1.
456-
**packageName** is the name of the package in CatalogSource should be subscribed
451+
and OperandRequest.\n1. **namespace** is the namespace where the operator will be deployed.\n1. **channel** is the name of OLM channel that is subscribed for the operator.\n1.
452+
**packageName** is the name of the package in CatalogSource that is subscribed
457453
for the operator.\n1. **sourceName** is the name of the CatalogSource.\n1. **sourceNamespace**
458-
is the namespaces of the CatalogSource.\n1. **description** is used to add a detailed
459-
description for service.\n\n\n## OperandConfig\n\nOperandConfig defines the individual
454+
is the namespace of the CatalogSource.\n1. **description** is used to add a detailed
455+
description of a service.\n\n\n## OperandConfig\n\nOperandConfig defines the individual
460456
operand deployment configuration.\nThe Operand Config Custom Resource (CR) defines
461-
the parameters for each operator listed in the above Registry that should be used
462-
to install the operator's operand by specifying an installation CR.\n\n**NOTE:**
463-
When ODLM operator is deployed, it will generate a default OperandConfig instance.
464-
You can edit it by your requirement. \n\n\n```yaml\napiVersion: operator.ibm.com/v1alpha1\nKind:
457+
the parameters for each operator that is listed in the OperandRegistry that should be used
458+
to install the operator instance by specifying an installation CR.\n\n**NOTE:**
459+
When ODLM operator is deployed, it generates a default OperandConfig instance.
460+
You can edit the instance as required. \n\n\n```yaml\napiVersion: operator.ibm.com/v1alpha1\nKind:
465461
OperandConfigs\nmetadata:\n name: common-service [1]\n namespace: ibm-common-services
466462
[2]\nspec:\n services:\n # suppose metering has three CRDs\n - name: ibm-metering-operator
467463
[3]\n spec: [4]\n reader:\n key: value\n nested:\n key:
468464
value\n server:\n key: value\n nested:\n key: value\n
469465
\ dataManager:\n key: value\n nested:\n key: value\n
470-
\ ...\n```\n\nOperandConfigs defines the individual operand deployment config:\n\n1.
466+
\ ...\n```\n\nOperandConfig defines the individual operand deployment config:\n\n1.
471467
Name of the OperandConfig\n1. Namespace of the OperandConfig\n1. **name** is the
472468
name of the operator, which should be the same as the services name in the OperandRegistry
473469
and OperandRequest.\n1. **spec** defines a map. Its key is the kind name of the
474-
custom resource. Its value will be merged to the spec field of custom resource.
475-
For more details you can check the below topic *How does ODLM create the individual
470+
custom resource. Its value is merged to the spec field of custom resource.
471+
For more details, you can check the following topic *How does ODLM create the individual
476472
operator CR?*\n\n### How does ODLM create the individual operator CR?\n\nSuppose
477-
IAM Operator has two CRDs: Apikey and Identity:\n\n- The OperandConfigs CR has\n```yaml\n-
473+
IAM Operator has two CRDs: Apikey and Identity:\n\n- The OperandConfig CR has\n```yaml\n-
478474
name: iam\n spec:\n apikey:\n key: value\n nested:\n key:
479475
value\n identity:\n key: value\n```\n\n- The IAM Operator CSV has\n```yaml\napiVersion:
480476
operators.coreos.com/v1alpha1\nkind: ClusterServiceVersion\nmetadata:\n annotations:\n
@@ -486,24 +482,24 @@ spec:
486482
\ \"kind\": \"Identity\",\n \"metadata\": {\n \"name\":
487483
\"iam-identity\"\n },\n \"spec\": {\n \"key\": \"value\",\n
488484
\ \"nested\": {\n \"key\": \"value\"\n }\n }\n
489-
\ }\n ]\n```\n\n- The ODLM will deep merge the OperandConfigs CR spec
485+
\ }\n ]\n```\n\n- The ODLM will deep merge the OperandConfig CR spec
490486
and IAM Operator CSV alm-examples to create the IAM CR.\n\n- For day2 operations,
491-
the ODLM will patch the OperandConfigs CR spec to the existing IAM CR.\n\nUsually
492-
the user should update the individual operator CR for day2 operations, but OperandConfigs
493-
still provide the ability for individual operator/operand day2 operation.\n\n\n##
494-
OperandRequest\n\nOperandRequest defines which operator/operand want to be installed
495-
in the cluster.\n\n**NOTE:** OperandRequest custom resource is used trigger a
487+
the ODLM will patch the OperandConfigs CR spec to the existing IAM CR.\n\nTypically,
488+
users update the individual operator CR for day2 operations, but OperandConfig
489+
still provides the ability for individual operator/operand day2 operation.\n\n\n##
490+
OperandRequest\n\nOperandRequest defines which operator/operand you want to install
491+
in the cluster.\n\n**NOTE:** OperandRequest custom resource is used to trigger a
496492
deployment for Operators and Operands. \n\n```yaml\napiVersion: operator.ibm.com/v1alpha1\nKind:
497493
OperandRequest\nmetadata:\n name: common-service [1]\n namespace: ibm-common-services
498494
[2]\nspec:\n requests:\n - registry: common-service [3]\n registryNamespace:
499495
ibm-common-services [4]\n operands: [5]\n - name: ibm-metering-operator
500496
[6]\n```\n\n1. Name of the OperandRequest\n1. Namespace of the OperandRequest\n1.
501-
**registry** identifies the name of the name of the OperandRegistry CR from which
497+
**registry** identifies the name of the OperandRegistry CR from which
502498
this operand deployment is being requested.\n1. **registryNamespace** identifies
503499
the namespace in which the catalog CR is defined. **Note:** If the catalog name
504500
and namespace are not specified then it is assumed that the Request (1) is for
505501
a catalog in the current (requester's) namespace and (2) that only one catalog
506-
exists in the namespace.\n1. **operands** in the CR is a list of `operand`. \n1.
502+
exists in the namespace.\n1. **operands** in the CR is a list of `operands`. \n1.
507503
**name** of **operands** in the CR must match a name specification in an OperandRegistry's
508504
CR.\n"
509505
displayName: Operand Deployment Lifecycle Manager

0 commit comments

Comments
 (0)