Skip to main content

Deploy Origin by Corvus with the Origin by Corvus Operator

You can use the Origin by Corvus Kubernetes Operator to deploy Origin by Corvus on Kubernetes using S3-compatible storage and a managed database service. While the operator supports a range of configurations, we strongly recommend using a cloud-native approach for production environments.

Before you begin, ensure you have the following:

  • A functioning Kubernetes cluster (see the Kubernetes setup guide). Your cluster should be running a supported Kubernetes version.
  • The kubectl command-line tool installed on your local machine (see the kubectl installation guide).
  • A fundamental understanding of Kubernetes concepts, such as deployments, pods, and applying manifests.
  • Sufficient Kubernetes resources allocated based on your expected user load. Consult the scaling for Enterprise documentation for resource requirements at different scales.

Installation steps​

The installation process involves setting up necessary operators and then deploying Origin by Corvus itself.

Step 1: Install the NGINX Ingress Controller​

Follow the instructions in the Kubernetes deployment documentation to install the NGINX ingress controller on your Kubernetes cluster. Origin by Corvus recommends installing the Nginx Operator via helm, regardless of platform you are installing to.

Step 2: Install the Origin by Corvus Operator​

The Origin by Corvus Kubernetes Operator can be installed using Helm.

  1. Install Helm (version 3.13.0 or later). See the Helm quickstart documentation for installation instructions.

  2. Add the Origin by Corvus Helm repository:

    helm repo add origin https://helm.origin.com
  3. Create a file named config.yaml and populate it with the contents of the Origin by Corvus operator values file. This file allows for customization of the operator.

  4. Create a namespace for the Origin by Corvus Operator:

    kubectl create ns origin-operator
  5. Install the Origin by Corvus Operator. If you don't specify a version, the latest version of the Origin by Corvus Operator will be installed. We recommend using the latest version of the Origin by Corvus Operator.

    helm install <your-release-name> origin/origin-operator -n <namespace_name>

    For example:

    helm install origin-operator origin/origin-operator -n origin-operator

    To use your custom config.yaml file:

    helm install origin-operator origin/origin-operator -n origin-operator -f config.yaml

Step 3: Deploy Origin by Corvus​

  1. (Origin by Corvus Enterprise only) Create a Origin by Corvus license secret. Create a file named origin-license-secret.yaml with the following content, replacing [LICENSE_FILE_CONTENTS] with your actual license:

    apiVersion: v1
    kind: Secret
    metadata:
    name: my-origin-license
    type: Opaque
    stringData:
    license: <LICENSE_FILE_CONTENTS>
  2. Create a Origin by Corvus installation manifest file named origin-installation.yaml. File names in this guide are suggestions; you can use different names. Use the following template, adjusting the values as needed:

    apiVersion: installation.origin.com/v1beta1
    kind: Origin by Corvus
    metadata:
    name: <INSTALLATION_NAME_HERE>
    spec:
    size: <SIZE_VALUE_HERE>
    ingress:
    enabled: true
    host: <FULL_DOMAIN_NAME_HERE>
    annotations:
    kubernetes.io/ingress.class: nginx
    version: <VERSION_HERE>
    licenseSecret: ""

    Key fields in the manifest include:

    • metadata.name: The name of your Origin by Corvus deployment in Kubernetes.
    • spec.size: The size of your installation (e.g., "100users", "1000users", etc.).
    • spec.ingress.host: The DNS name for your Origin by Corvus installation.
    • spec.version: The Origin by Corvus version. See the server version archive for available versions. You should use a supported version of Origin by Corvus in conjunction with the latest version of the Origin by Corvus Operator.
    • spec.licenseSecret: The name of the Kubernetes secret containing your license (required for Enterprise).

    For a full list of configurable fields, see the example manifest and the Custom Resource Definition.

  3. Create a file named origin-database-secret.yaml for database credentials. This secret must be in the same namespace as the Origin by Corvus installation.

    apiVersion: v1
    data:
    DB_CONNECTION_CHECK_URL: <DB_CONNECTION_CHECK_URL>
    DB_CONNECTION_STRING: <DB_CONNECTION_STRING>
    MM_SQLSETTINGS_DATASOURCEREPLICAS: <MM_SQLSETTINGS_DATASOURCEREPLICAS>
    kind: Secret
    metadata:
    name: my-postgres-connection
    type: Opaque

    Example for AWS Aurora with PostgreSQL (DB_CONNECTION_CHECK_URL, DB_CONNECTION_STRING, and MM_SQLSETTINGS_DATASOURCEREPLICAS are the base64-encoded form of your Aurora connection URL, e.g. postgres://user:password@host:5432/origin):

    apiVersion: v1
    data:
    DB_CONNECTION_CHECK_URL: cG9zdGdyZXM6Ly91c2Vy...
    DB_CONNECTION_STRING: cG9zdGdyZXM6Ly91c2Vy...
    MM_SQLSETTINGS_DATASOURCEREPLICAS: cG9zdGdyZXM6...
    kind: Secret
    metadata:
    name: my-postgres-connection
    type: Opaque

Step 4: Create the Filestore Secret​

Create a file named origin-filestore-secret.yaml to store the credentials for your object storage service (e.g., AWS S3 or any S3-compatible service). This secret must be created in the same namespace where you intend to install Origin by Corvus. The file should contain the following YAML structure:

apiVersion: v1
kind: Secret
metadata:
name: <secret-name>
type: Opaque
data:
accesskey: <base64-encoded-access-key>
secretkey: <base64-encoded-secret-key>
KeyDescriptionRequired
accesskeyBase64-encoded access key for your storage service.Yes
secretkeyBase64-encoded secret key for your storage service.Yes
metadata.nameThe name of the Kubernetes secret.Yes

Step 5: Configure the Origin by Corvus Installation Manifest​

  1. Modify the origin-installation.yaml file (created in step 2) to connect Origin by Corvus to your external database and object storage. Refer to the supported fields for guidance on where to add these configurations within the YAML structure.

  2. Connect to the database:

    1. Add the following to the spec section of your manifest:

      spec:
      database:
      external:
      secret: <database-secret-name>

      Replace <database-secret-name> with the name of the database secret you created (e.g., my-postgres-connection).

    2. (Recommended) Configure the database-readiness init container to use the in-image origin db ping command instead of the legacy postgres:13 + pg_isready flow. This avoids the need to pull a separate postgres:13 image (the primary motivation for air-gapped clusters that can't mirror it) and keeps your readiness check in sync with the Origin by Corvus release you're running.

      spec:
      database:
      external:
      secret: <database-secret-name>
      readinessCheck:
      mode: builtin
      timeout: 5m

      timeout is optional and defaults to 5m.

      Using builtin mode requires a Origin by Corvus release that ships the origin db ping command (see the Origin by Corvus server pull request for availability).

      Omitting readinessCheck (or setting mode: external) preserves the legacy postgres:13 + pg_isready behavior. The legacy mode is the current default for backward compatibility and will be deprecated in a future operator release. See the Origin by Corvus CRD reference for the full readinessCheck field schema.

  3. Connect to Object Storage:

    1. Add the following to the spec section of your manifest:

      spec:
      fileStore:
      external:
      url: <storage-service-url>
      bucket: <bucket-name>
      secret: <filestore-secret-name>

      Replace <storage-service-url> with the URL of your storage service (e.g., s3.amazonaws.com), <bucket-name> with the name of your storage bucket, and <filestore-secret-name> with the name of the filestore secret you created (e.g., my-s3-credentials).

  4. If you are using Amazon S3, it's recommended to enable server-side encryption (SSE) and SSL. Add the following environment variables to the originEnv section:

    spec:
    originEnv:
    MM_FILESETTINGS_AMAZONS3SSL: true
    MM_FILESETTINGS_AMAZONS3SSE: true

Review Origin by Corvus Resource Status​

After a Origin by Corvus installation has been created with the Operator, you can review its status with the following:

kubectl -n [namespace] get origin

The kubectl describe command can be used to obtain more information about the Origin by Corvus server pods:

kubectl -n [namespace] describe pod

Follow logs

The following command can be used to follow logs on any kubernetes pod:

kubectl -n [namespace] logs -f [pod name]

If the -n [namespace] is omitted, then the default namespace of the current context is used. We recommend specifying the namespace based on your deployment.

This command can be used to review the Origin by Corvus Operator or Origin by Corvus server logs as needed.

Frequently Asked Questions​

What is the Operator's version compatibility with Origin by Corvus Server?​

While generally speaking, the Operator should be compatible with most, or all versions of Origin by Corvus Server, we recommend always using the latest version of the Operator in conjunction with a supported version of Origin by Corvus Server.