velero/docs/config-definition.md

Ark Config definition and Ark server deployment

• Config
  • Example
  • Parameter Reference
    • Main config
    • AWS
    • GCP
    • Azure
• Deployment
  • Sample Deployment
  • Parameter Options

Config

Heptio Ark defines its own Config object (a custom resource) for specifying Ark backup and cloud provider settings. When the Ark server is first deployed, it waits until you create a Config --specifically one named default-- in the heptio-ark namespace.

Note

: There is an underlying assumption that you're running the Ark server as a Kubernetes deployment. If the default Config is modified, the server shuts down gracefully. Once the kubelet restarts the Ark server pod, the server then uses the updated Config values.

Example

A sample YAML Config looks like the following:

apiVersion: ark.heptio.com/v1
kind: Config
metadata:
  namespace: heptio-ark
  name: default
persistentVolumeProvider:
  name: aws
  config:
    region: us-west-2
backupStorageProvider:
  name: aws
  bucket: ark
  config:
    region: us-west-2

Parameter Reference

The configurable parameters are as follows:

Main config parameters

Key	Type	Default	Meaning
persistentVolumeProvider	CloudProviderConfig	None (Optional)	The specification for whichever cloud provider the cluster is using for persistent volumes (to be snapshotted), if any. If not specified, Backups and Restores requesting PV snapshots & restores, respectively, are considered invalid. NOTE: For Azure, your Kubernetes cluster needs to be version 1.7.2+ in order to support PV snapshotting of its managed disks.
persistentVolumeProvider/name	String (Ark natively supports aws, gcp, and azure. Other providers may be available via external plugins.)	None (Optional)	The name of the cloud provider the cluster is using for persistent volumes, if any.
persistentVolumeProvider/config	map[string]string (See the corresponding AWS, GCP, and Azure-specific configs or your provider's documentation.)	None (Optional)	Configuration keys/values to be passed to the cloud provider for persistent volumes.
backupStorageProvider	CloudProviderConfig	Required Field	The specification for whichever cloud provider will be used to actually store the backups.
backupStorageProvider/name	String (Ark natively supports aws, gcp, and azure. Other providers may be available via external plugins.)	Required Field	The name of the cloud provider that will be used to actually store the backups.
backupStorageProvider/bucket	String	Required Field	The storage bucket where backups are to be uploaded.
backupStorageProvider/config	map[string]string (See the corresponding AWS, GCP, and Azure-specific configs or your provider's documentation.)	None (Optional)	Configuration keys/values to be passed to the cloud provider for backup storage.

AWS

(Or other S3-compatible storage)

backupStorageProvider/config

Key	Type	Default	Meaning
region	string	Empty	Example: "us-east-1" See AWS documentation for the full list. Queried from the AWS S3 API if not provided.
s3ForcePathStyle	bool	false	Set this to true if you are using a local storage service like Minio.
s3Url	string	Required field for non-AWS-hosted storage	Example: http://minio:9000 You can specify the AWS S3 URL here for explicitness, but Ark can already generate it from region, and bucket. This field is primarily for local storage services like Minio.
kmsKeyId	string	Empty	Example: "502b409c-4da1-419f-a16e-eif453b3i49f" or "alias/<KMS-Key-Alias-Name>" Specify an AWS KMS key id or alias to enable encryption of the backups stored in S3. Only works with AWS S3 and may require explicitly granting key usage rights.

persistentVolumeProvider/config (AWS Only)

Key	Type	Default	Meaning
region	string	Required Field	Example: "us-east-1" See AWS documentation for the full list.

GCP

backupStorageProvider/config

No parameters required.

persistentVolumeProvider/config

No parameters required.

Azure

backupStorageProvider/config

No parameters required.

persistentVolumeProvider/config

Key	Type	Default	Meaning
apiTimeout	metav1.Duration	2m0s	How long to wait for an Azure API request to complete before timeout.

Deployment

Heptio Ark also defines its own Deployment object for starting the Ark server on Kubernetes. When the Ark server is deployed, there are specific configurations that might be changed.

Sample Deployment

A sample YAML Deployment looks like the following:

apiVersion: apps/v1beta1
kind: Deployment
metadata:
  namespace: heptio-ark
  name: ark
spec:
  replicas: 1
  template:
    metadata:
      labels:
        component: ark
      annotations:
        prometheus.io/scrape: "true"
        prometheus.io/port: "8085"
        prometheus.io/path: "/metrics"
    spec:
      restartPolicy: Always
      serviceAccountName: ark
      containers:
        - name: ark
          image: gcr.io/heptio-images/ark:latest
          command:
            - /ark
          args:
            - server
            - --backup-sync-period
            - 30m
          volumeMounts:
            - name: cloud-credentials
              mountPath: /credentials
            - name: plugins
              mountPath: /plugins
            - name: scratch
              mountPath: /scratch
          env:
            - name: AWS_SHARED_CREDENTIALS_FILE
              value: /credentials/cloud
            - name: ARK_SCRATCH_DIR
              value: /scratch
      volumes:
        - name: cloud-credentials
          secret:
            secretName: cloud-credentials
        - name: plugins
          emptyDir: {}
        - name: scratch
          emptyDir: {}

Parameter Options

The list of configurable options for the ark server deployment can be found on the CLI reference document.