Get started
Calyptia CLI reference

Calyptia CLI reference

# calyptia create core_instance operator --help
Setup a new core operator instance

Usage:
  calyptia create core_instance operator [flags]

Aliases:
  operator, opr

Flags:
      --annotations string                          Custom annotations for pipelines. Format should be 'annotation1=value1,annotation2=value2'
      --core-cloud-url string                       Override the cloud URL for the core operator instance
      --dry-run                                     Passing this value will skip creation of any Kubernetes resources and it will return resources as YAML manifest
      --enable-cluster-logging                      Enable cluster logging pipeline creation.
      --environment string                          Calyptia environment name
      --fluent-bit-image string                     Calyptia core fluent-bit image to use.
      --health-check-pipeline-port-number string    Port number to expose the health-check pipeline
      --health-check-pipeline-service-type string   Service type to use for health-check pipeline, options: ClusterIP,LoadBalancer,NodePort
  -h, --help                                        help for operator
      --http-proxy string                           http proxy to use on this core instance
      --https-proxy string                          http proxy to use on this core instance
      --kube-as string                              Username to impersonate for the operation
      --kube-as-group stringArray                   Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --kube-as-uid string                          UID to impersonate for the operation
      --kube-certificate-authority string           Path to a cert file for the certificate authority
      --kube-client-certificate string              Path to a client certificate file for TLS
      --kube-client-key string                      Path to a client key file for TLS
      --kube-cluster string                         The name of the kubeconfig cluster to use
      --kube-context string                         The name of the kubeconfig context to use
      --kube-disable-compression                    If true, opt-out of response compression for all requests to the server
      --kube-insecure-skip-tls-verify               If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
  -n, --kube-namespace string                       If present, the namespace scope for this Calyptia CLI request
      --kube-password string                        Password for basic authentication to the API server
      --kube-proxy-url string                       If provided, this URL will be used to connect via proxy
      --kube-request-timeout string                 The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
      --kube-server string                          The address and port of the Kubernetes API server
      --kube-tls-server-name string                 If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used.
      --kube-token string                           Bearer token for authentication to the API server
      --kube-user string                            The name of the kubeconfig user to use
      --kube-username string                        Username for basic authentication to the API server
      --memory-limit string                         Minimum memory required (default "512Mi")
      --metrics-port string                         Port for metrics endpoint. (default "15334")
      --name string                                 Core instance name (autogenerated if empty)
      --no-health-check-pipeline                    Disable health check pipeline creation alongside the core instance
      --no-tls-verify                               Disable TLS verification when connecting to Calyptia Cloud API.
      --skip-service-creation                       Skip the creation of Kubernetes services for any pipeline under this core instance.
      --tags strings                                Tags to apply to the core instance
      --timeout duration                            Wait timeout (default 30s)
      --wait                                        Wait for the core instance to be ready before returning

Global Flags:
      --cloud-url string   Calyptia Cloud URL (default "https://cloud-api.calyptia.com")
      --token string       Calyptia Cloud Project token (default "check with the 'calyptia config current_token' command")

Example usage

Create core_instance in the cluster with desired name and in desired namespace.

calyptia create core_instance operator --kube-namespace <desired namespace> --name <desired name>

Create core_instance in the cluster and override default Cloud URL and Cloud API token

calyptia create core_instance operator --name <desired name> --cloud-url <desired cloud URL> --token <Cloud API token>

Create core_instance in the cluster and pass custom annotations

calyptia create core_instance operator --name <desired name> --annotations annotation1=value1,annotation2=value2