couchdb-operator.clusterserviceversion.yaml

apiVersion: operators.coreos.com/v1alpha1
kind: ClusterServiceVersion
metadata:
  labels:
    operatorframework.io/arch.amd64: supported
    operatorframework.io/os.linux: supported
    operatorframework.io/arch.s390x: supported
    operatorframework.io/arch.ppc64le: supported
  annotations:
    alm-examples: |-
      [
        {
            "apiVersion": "couchdb.databases.cloud.ibm.com/v1",
            "kind": "CouchDBCluster",
            "metadata": {
                "name": "example-couchdbcluster"
            },
            "spec": {
                "cpu": "1",
                "disk": "1Gi",
                "storageClass": "",
                "environment": {
                    "adminPassword": "changeme",
                    "search": true
                },
                "memory": "1Gi",
                "size": 3
            }
        },
        {
            "apiVersion": "couchdb.databases.cloud.ibm.com/v1",
            "kind": "FormationLock",
            "metadata": {
                "name": "example-formationlock"
            },
            "spec": {}
        },
        {
            "apiVersion": "couchdb.databases.cloud.ibm.com/v1",
            "kind": "Recipe",
            "metadata": {
                "name": "example-recipe"
            },
            "spec": {}
        },
        {
            "apiVersion": "couchdb.databases.cloud.ibm.com/v1",
            "kind": "RecipeTemplate",
            "metadata": {
                "name": "example-recipetemplate"
            },
            "spec": {}
        },
        {
            "apiVersion": "couchdb.databases.cloud.ibm.com/v1",
            "kind": "Backup",
            "metadata": {
                "name": "example-backup"
            },
            "spec": {}
        },
        {
            "apiVersion": "couchdb.databases.cloud.ibm.com/v1",
            "kind": "Bucket",
            "metadata": {
                "name": "example-bucket"
            },
            "spec": {}
        },
        {
            "apiVersion": "couchdb.databases.cloud.ibm.com/v1",
            "kind": "Formation",
            "metadata": {
                "name": "example-formation"
            },
            "spec": {}
        }
      ]
    capabilities: Seamless Upgrades
    categories: Database
    certified: "true"
    containerImage: icr.io/cpopen/couchdb-operator@sha256:a14bda7dc34d823496679e41da499fcde21461c68a27de81e98dc19cfdf7fc86
    createdAt: "2022-01-25T15:00:04Z"
    description: |
      Apache CouchDB is a highly available NOSQL database for web and mobile applications
    support: IBM
    operators.operatorframework.io/internal-objects: '["backups.couchdb.databases.cloud.ibm.com","buckets.couchdb.databases.cloud.ibm.com","formationlocks.couchdb.databases.cloud.ibm.com","formations.couchdb.databases.cloud.ibm.com","recipes.couchdb.databases.cloud.ibm.com","recipetemplates.couchdb.databases.cloud.ibm.com"]'
    operators.openshift.io/infrastructure-features: '["disconnected"]'
  name: couchdb-operator.v2.2.1
  namespace: placeholder
spec:
  displayName: Operator for Apache CouchDB
  replaces: couchdb-operator.v2.2.0
  apiservicedefinitions: {}
  minKubeVersion: 1.14.0
  customresourcedefinitions:
    owned:
    - description: |
            Represents a deployment of an Apache CouchDB cluster
        
            License
            By installing this product you accept the license terms http://www.apache.org/licenses/LICENSE-2.0
      displayName: CouchDB Cluster
      kind: CouchDBCluster
      name: couchdbclusters.couchdb.databases.cloud.ibm.com
      resources: 
      - kind: Formation
        name: formations.couchdb.databases.cloud.ibm.com
        version: v1
      specDescriptors:
      - description: Number of CouchDB nodes in the cluster
        displayName: Cluster size
        path: size
        x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:podCount
      - description: Storage class to use
        displayName: Storage class
        path: storageClass
        x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:text
      - description: The Admin Password of CouchDB
        displayName: Admin Password
        path: environment.adminPassword
        x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:password
      - description: Alters defaults for use in a development setting, note this will disable TLS
        displayName: Development Mode
        path: devMode
        x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
      - description: Specify the resouce requirements and limits for the database container
        displayName: DB Resource Requirements (Optional)
        path: resources.db
        x-descriptors:
        - 'urn:alm:descriptor:com.tectonic.ui:resourceRequirements'
      - description: Specify the resouce requirements and limits for the search container
        displayName: Search Resource Requirements (Optional)
        path: resources.search
        x-descriptors:
        - 'urn:alm:descriptor:com.tectonic.ui:resourceRequirements'
      - description: Specify the resouce requirements and limits for the management container
        displayName: Management Resource Requirements (Optional)
        path: resources.mgmt
        x-descriptors:
        - 'urn:alm:descriptor:com.tectonic.ui:resourceRequirements'
      version: v1
    - description: Internal representation of a CouchDB Backup. Used internally by
        the Operator for Apache CouchDB.
      displayName: (Internal) CouchDB Backup
      kind: Backup
      name: backups.couchdb.databases.cloud.ibm.com
      version: v1
    - description: Internal representation of a COS Bucket. Used internally by the
        Operator for Apache CouchDB.
      displayName: (Internal) CouchDB COS Bucket
      kind: Bucket
      name: buckets.couchdb.databases.cloud.ibm.com
      version: v1
    - description: Internal representation of a CouchDB Cluster. Used internally by
        the Operator for Apache CouchDB.
      displayName: (Internal) CouchDB Formation
      kind: Formation
      name: formations.couchdb.databases.cloud.ibm.com
      resources:
      - kind: Service
        name: ''
        version: v1
      - kind: StatefulSet
        name: ''
        version: apps/v1
      - kind: ServiceAccount
        name: ''
        version: v1
      - kind: NetworkPolicy
        name: ''
        version: networking.k8s.io/v1
      version: v1
    - description: Internal lock on a CouchDB Formation. Used internally by the Operator
        for Apache CouchDB.
      displayName: (Internal) CouchDB Formation Lock
      kind: FormationLock
      name: formationlocks.couchdb.databases.cloud.ibm.com
      version: v1
    - description: Internal recipe for CouchDB. Used internally by the Operator for
        Apache CouchDB.
      displayName: (Internal) CouchDB Recipe
      kind: Recipe
      name: recipes.couchdb.databases.cloud.ibm.com
      version: v1
    - description: Internal recipe template for CouchDB. Used internally by the Operator
        for Apache CouchDB.
      displayName: (Internal) CouchDB Recipe Template
      kind: RecipeTemplate
      name: recipetemplates.couchdb.databases.cloud.ibm.com
      version: v1
  description: |
    Apache CouchDB lets you access your data where you need it. The [Couch Replication Protocol](http://docs.couchdb.org/en/master/replication/protocol.html) is implemented in a variety of projects and products that span every imaginable computing environment from globally distributed server-clusters, over mobile phones to web browsers.

    Store your data safely, on your own servers, or with any leading cloud provider. Your web- and native applications love CouchDB, because it speaks JSON natively and supports binary data for all your data storage needs.

    The [Couch Replication Protocol](http://docs.couchdb.org/en/master/replication/protocol.html) lets your data flow seamlessly between server clusters to mobile phones and web browsers, enabling a compelling [offline-first](http://offlinefirst.org/) user-experience while maintaining high performance and strong reliability. CouchDB comes with a developer-friendly query language, and optionally MapReduce for simple, efficient, and comprehensive data retrieval.

    ### Operator for Apache CouchDB Features
    * Fully automated deployment and configuration of Apache CouchDB clusters.
    * Support single, multiple, or all namespace install modes.

    #### Security
    * TLS - TLS  is supported using user-provided certificates.
    * Authentication - The parameter `require_valid_user` defaults to `true`, which means that no requests are allowed from anonymous users. Every request must be authenticated.
    * Authorization - Databases are initially accessible by Apache CouchDB admins only.

    #### High Availability
    * Nodes - Each database node in an Apache CouchDB cluster requires its own Kubernetes node. It's recommended that you run it with a minimum of three nodes for any production deployment.
    * Zones - The Apache CouchDB cluster database nodes are spread across available Kubernetes fault zones where available.
    * Replicas - The default configuration for each database is two shards (Q=2) and three shard copies (N=3), where each shard copy is deployed on a separate node in the cluster.

    ### Reading and writing to Apache CouchDB

    The Operator for Apache CouchDB automatically generates a Service. This can be accessed using port-forwarding e.g. `kubectl port-forward svc/my-couchdb-cluster 443:443 -u admin:mypassword`. Alternatively, configure an Ingress to expose the service externally.

    ### CouchDB 2.3.1 Update Instructions
    When the operator is updated to v2.0 or above any existing CouchDB 2.3.1 cluster will not be automatically upgraded to CouchDB 3. The user must manually trigger this process by removing the version statement `version: 2.3.1` in the CouchDBCluster CR for each CouchDB cluster
    The operator will then perform a rolling update, with the new pods running CouchDB3.
    It is advised that customers do this straightaway as CouchDB 2.3.1 is no longer supported.

    [Read the complete guide to using the Operator for Apache CouchDB](https://ibm.biz/BdfGQy)
  icon:
  - base64data: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iaXNvLTg4NTktMSI/Pgo8IS0tIEdlbmVyYXRvcjogQWRvYmUgSWxsdXN0cmF0b3IgMTYuMC4zLCBTVkcgRXhwb3J0IFBsdWctSW4gLiBTVkcgVmVyc2lvbjogNi4wMCBCdWlsZCAwKSAgLS0+CjwhRE9DVFlQRSBzdmcgUFVCTElDICItLy9XM0MvL0RURCBTVkcgMS4xLy9FTiIgImh0dHA6Ly93d3cudzMub3JnL0dyYXBoaWNzL1NWRy8xLjEvRFREL3N2ZzExLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiCgkgd2lkdGg9IjEwOS43MTRweCIgaGVpZ2h0PSI3MnB4IiB2aWV3Qm94PSIwIDAgMTA5LjcxNCA3MiIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgMTA5LjcxNCA3MjsiIHhtbDpzcGFjZT0icHJlc2VydmUiPgo8Zz4KCTxkZWZzPgoJCTxyZWN0IGlkPSJTVkdJRF8xXyIgd2lkdGg9IjEwOS43MTQiIGhlaWdodD0iNzIiLz4KCTwvZGVmcz4KCTxjbGlwUGF0aCBpZD0iU1ZHSURfMl8iPgoJCTx1c2UgeGxpbms6aHJlZj0iI1NWR0lEXzFfIiAgc3R5bGU9Im92ZXJmbG93OnZpc2libGU7Ii8+Cgk8L2NsaXBQYXRoPgoJPHBhdGggc3R5bGU9ImNsaXAtcGF0aDp1cmwoI1NWR0lEXzJfKTtmaWxsOiNFNDI1Mjg7IiBkPSJNODkuMTQzLDQ4YzAsNC41NDctMi4zOTUsNi43NzQtNi44NTcsNi44NTR2MC4wMDNIMjcuNDI5di0wLjAwMwoJCWMtNC40NjItMC4wNzktNi44NTctMi4zMDctNi44NTctNi44NTRjMC00LjU0NiwyLjM5NS02Ljc3NCw2Ljg1Ny02Ljg1NHYtMC4wMDRoNTQuODU2djAuMDA0CgkJQzg2Ljc0OCw0MS4yMjYsODkuMTQzLDQzLjQ1NCw4OS4xNDMsNDggTTgyLjI4NSw1OC4yOXYtMC4wMDRIMjcuNDI5djAuMDA0Yy00LjQ2MiwwLjA3OC02Ljg1NywyLjMwNi02Ljg1Nyw2Ljg1MwoJCXMyLjM5NSw2Ljc3NSw2Ljg1Nyw2Ljg1NFY3Mmg1NC44NTZ2LTAuMDA0YzQuNDYzLTAuMDc4LDYuODU3LTIuMzA3LDYuODU3LTYuODU0Uzg2Ljc0OCw1OC4zNjgsODIuMjg1LDU4LjI5IE05OS40MjksMjAuNTc5di0wLjAwNAoJCWMtNC40NjIsMC4wNzktNi44NTcsMi4zMDctNi44NTcsNi44NTR2MzcuNzE0YzAsNC41NDcsMi4zOTYsNi43NzUsNi44NTcsNi44NTR2LTAuMDA3YzYuNjkzLTAuMjM2LDEwLjI4Ni02LjkyLDEwLjI4Ni0yMC41NjEKCQlWMzQuMjg2QzEwOS43MTUsMjUuMTkzLDEwNi4xMjIsMjAuNzM3LDk5LjQyOSwyMC41NzkgTTEwLjI4NiwyMC41NzV2MC4wMDRDMy41OTQsMjAuNzM3LDAsMjUuMTkzLDAsMzQuMjg2djE3LjE0MwoJCWMwLDEzLjY0MSwzLjU5NCwyMC4zMjQsMTAuMjg2LDIwLjU2MXYwLjAwN2M0LjQ2Mi0wLjA3OCw2Ljg1Ny0yLjMwNyw2Ljg1Ny02Ljg1NFYyNy40MjkKCQlDMTcuMTQzLDIyLjg4MiwxNC43NDgsMjAuNjU0LDEwLjI4NiwyMC41NzUgTTk5LjQyOSwxNy4xNDNjMC0xMS4zNjctNS45ODgtMTYuOTM3LTE3LjE0NC0xNy4xMzNWMEgyNy40Mjl2MC4wMQoJCUMxNi4yNzQsMC4yMDYsMTAuMjg2LDUuNzc2LDEwLjI4NiwxNy4xNDN2MC4wMDZjNi42OTMsMC4xMTgsMTAuMjg2LDMuNDYsMTAuMjg2LDEwLjI4YzAsNi44MiwzLjU5MywxMC4xNjIsMTAuMjg2LDEwLjI4djAuMDA1aDQ4CgkJdi0wLjAwNWM2LjY5Mi0wLjExOCwxMC4yODUtMy40NiwxMC4yODUtMTAuMjhjMC02LjgyLDMuNTkzLTEwLjE2MiwxMC4yODYtMTAuMjhWMTcuMTQzeiIvPgo8L2c+Cjwvc3ZnPgo=
    mediatype: image/svg+xml
  install:
    spec:
      clusterPermissions:
      - rules:
        - apiGroups:
          - ""
          resources:
          - namespaces
          - persistentvolumes
          verbs:
          - get
          - list
          - watch
        serviceAccountName: couchdb-operator
      deployments:
      - name: couchdb-operator
        spec:
          selector:
            matchLabels:
              name: couchdb-operator
          strategy: {}
          template:
            metadata:
              labels:
                name: couchdb-operator
            spec:
              affinity:
                nodeAffinity:
                  requiredDuringSchedulingIgnoredDuringExecution:
                    nodeSelectorTerms:
                    - matchExpressions:
                      - key: kubernetes.io/arch
                        operator: In
                        values: [amd64,s390x,ppc64le]
                  preferredDuringSchedulingIgnoredDuringExecution:
                  - weight: 3
                    preference:
                      matchExpressions:
                      - key: kubernetes.io/arch
                        operator: In
                        values: [amd64,s390x,ppc64le]
              containers:
              - env:
                - name: RELATED_IMAGE_COUCHDB3
                  value: quay.io/opencloudio/couchdb3@sha256:071c548bbb2888057537ca12c9cf8fccf3aab4e8de40e7dbad5b028c1291546d
                - name: RELATED_IMAGE_MGMT
                  value: quay.io/opencloudio/couchdb-operator-mgmt@sha256:ee45180fbce0d1b78ed2e89d07e99b51dfa5e59d2e0e427e69fbdfe792616299
                - name: WATCH_NAMESPACE
                  valueFrom:
                    fieldRef:
                      fieldPath: metadata.annotations['olm.targetNamespaces']
                - name: OPERATOR_NAMESPACE
                  valueFrom:
                    fieldRef:
                      fieldPath: metadata.namespace
                - name: REGISTRY_SECRET
                image: icr.io/cpopen/couchdb-operator@sha256:a14bda7dc34d823496679e41da499fcde21461c68a27de81e98dc19cfdf7fc86
                imagePullPolicy: IfNotPresent
                args: ["-registry=quay.io/opencloudio", "--v=2", "--architecture=amd64,s390x,ppc64le"]
                name: couchdb-operator
                resources:
                  limits:
                    cpu: 1
                    memory: 1Gi
                  requests:
                    cpu: 100m
                    memory: 256Mi
              serviceAccountName: couchdb-operator
      permissions:
      - rules:
        - apiGroups:
          - ""
          resources:
          - deployments
          - deployments/scale
          - events
          - endpoints
          - services
          - configmaps
          - secrets
          - pods
          - pods/exec
          - persistentvolumeclaims
          - namespaces
          verbs:
          - '*'
        - apiGroups:
          - ""
          resources:
          - persistentvolumes
          verbs:
          - get
          - update
          - patch
          - list
          - watch
        - apiGroups:
          - apps
          resources:
          - statefulsets
          - replicasets
          - deployments
          - deployments/scale
          verbs:
          - '*'
        - apiGroups:
          - extensions
          resources:
          - networkpolicies
          - deployments
          - deployments/scale
          verbs:
          - '*'
        - apiGroups:
          - networking.k8s.io
          resources:
          - networkpolicies
          verbs:
          - '*'
        - apiGroups:
          - rbac.authorization.k8s.io
          resources:
          - roles
          - rolebindings
          verbs:
          - get
          - create
          - delete
          - update
          - list
          - watch
        - apiGroups:
          - ""
          resources:
          - serviceaccounts
          verbs:
          - get
          - create
          - delete
          - update
          - list
          - watch
        - apiGroups:
          - couchdb.databases.cloud.ibm.com
          resources:
          - '*'
          verbs:
          - '*'
        - apiGroups:
          - batch
          resources:
          - cronjobs
          verbs:
          - '*'
        - apiGroups:
          - policy
          resources:
          - poddisruptionbudgets
          verbs:
          - get
          - create
          - delete
          - list
          - watch
        - apiGroups:
          - apps
          resourceNames:
          - couchdb-operator
          resources:
          - deployments/finalizers
          verbs:
          - update
        serviceAccountName: couchdb-operator
    strategy: deployment
  installModes:
  - supported: true
    type: OwnNamespace
  - supported: true
    type: SingleNamespace
  - supported: true
    type: MultiNamespace
  - supported: true
    type: AllNamespaces
  keywords:
  - Apache
  - CouchDB
  - Cloudant
  - NoSQL
  links:
  - name: Apache CouchDB Homepage
    url: http://couchdb.apache.org/
  - name: Documentation
    url: https://ibm.biz/BdfGQy
  maintainers:
  - email: support@cloudant.com
    name: IBM
  maturity: stable
  provider:
    name: IBM
  version: 2.2.1
  relatedImages: 
  - name: COUCHDB3
    image: quay.io/opencloudio/couchdb3@sha256:071c548bbb2888057537ca12c9cf8fccf3aab4e8de40e7dbad5b028c1291546d
  - name: COUCHDB-MGMT
    image: quay.io/opencloudio/couchdb-operator-mgmt@sha256:ee45180fbce0d1b78ed2e89d07e99b51dfa5e59d2e0e427e69fbdfe792616299