diff --git a/README.md b/README.md index 86d805c06..822e0df6c 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ NOTE: Make sure to check out the appropriate version. We recommend that you chec 1. Check to see that both the Ark and nginx deployments are successfully created: ``` - kubectl get deployments -l component=ark --namespace=heptio-ark-server + kubectl get deployments -l component=ark --namespace=heptio-ark kubectl get deployments --namespace=nginx-example ``` @@ -137,19 +137,26 @@ For more information, see [the debugging information][18]. ### Clean up -Delete any backups you created: +If you want to delete any backups you created, including data in object storage and persistent +volume snapshots, you can run: ``` -kubectl delete -n heptio-ark backup --all +ark backup delete BACKUP_NAME ``` -Before you continue, wait for the following to show no backups: +This asks the Ark server to delete all backup data associated with `BACKUP_NAME`. You need to do +this for each backup you want to permanently delete. A future version of Ark will allow you to +delete multiple backups by name or label selector. + +Once fully removed, the backup is no longer visible when you run: ``` -ark backup get +ark backup get BACKUP_NAME ``` -To remove the Kubernetes objects for this example from your cluster, run: +If you want to uninstall Ark but preserve the backup data in object storage and persistent volume +snapshots, it is safe to remove the `heptio-ark` namespace and everything else created for this +example: ``` kubectl delete -f examples/common/ diff --git a/docs/aws-config.md b/docs/aws-config.md index 83ff8e3d5..d9c0ac138 100644 --- a/docs/aws-config.md +++ b/docs/aws-config.md @@ -131,7 +131,7 @@ Create a Secret. In the directory of the credentials file you just created, run: ```bash kubectl create secret generic cloud-credentials \ - --namespace \ + --namespace \ --from-file cloud=credentials-ark ``` diff --git a/docs/azure-config.md b/docs/azure-config.md index fff47d50a..0d19957f2 100644 --- a/docs/azure-config.md +++ b/docs/azure-config.md @@ -115,7 +115,7 @@ Now you need to create a Secret that contains all the seven environment variable ```bash kubectl create secret generic cloud-credentials \ - --namespace \ + --namespace \ --from-literal AZURE_SUBSCRIPTION_ID=${AZURE_SUBSCRIPTION_ID} \ --from-literal AZURE_TENANT_ID=${AZURE_TENANT_ID} \ --from-literal AZURE_RESOURCE_GROUP=${AZURE_RESOURCE_GROUP} \ diff --git a/docs/gcp-config.md b/docs/gcp-config.md index a48310b3f..2ccb72885 100644 --- a/docs/gcp-config.md +++ b/docs/gcp-config.md @@ -74,7 +74,7 @@ Create a Secret. In the directory of the credentials file you just created, run: ```bash kubectl create secret generic cloud-credentials \ - --namespace \ + --namespace \ --from-file cloud=credentials-ark ``` diff --git a/docs/ibm-config.md b/docs/ibm-config.md index 8a1ea4428..884b621be 100644 --- a/docs/ibm-config.md +++ b/docs/ibm-config.md @@ -47,7 +47,7 @@ Create a Secret. In the directory of the credentials file you just created, run: ```bash kubectl create secret generic cloud-credentials \ - --namespace \ + --namespace \ --from-file cloud=credentials-ark ``` diff --git a/docs/namespace.md b/docs/namespace.md index fab6f0c83..d3b801a5d 100644 --- a/docs/namespace.md +++ b/docs/namespace.md @@ -7,14 +7,14 @@ you run Ark client commands. ## Edit the example files The Ark repository includes [a set of examples][0] that you can use to set up your Ark server. The -examples place the server in the `heptio-ark-server` namespace, and backup/schedule/restore/config -data in the `heptio-ark` namespace. +examples place the server and backup/schedule/restore/config data in the `heptio-ark` namespace. -To run the server in another namespace, you edit the relevant files, changing `heptio-ark-server` to +To run the server in another namespace, you edit the relevant files, changing `heptio-ark` to your desired namespace. To store your backups, schedules, restores, and config in another namespace, you edit the relevant -files, changing `heptio-ark` to your desired namespace. +files, changing `heptio-ark` to your desired namespace. You also need to create the +`cloud-credentials` secret in your desired namespace. WARNING: It is recommended to run the Ark server in one namespace, and place your backups, schedules, restores, and config in a different namespace. You might encounter issues with deleting a single Ark diff --git a/examples/azure/00-ark-deployment.yaml b/examples/azure/00-ark-deployment.yaml index d97aceaad..528bcd5b0 100644 --- a/examples/azure/00-ark-deployment.yaml +++ b/examples/azure/00-ark-deployment.yaml @@ -16,7 +16,7 @@ apiVersion: apps/v1beta1 kind: Deployment metadata: - namespace: heptio-ark-server + namespace: heptio-ark name: ark spec: replicas: 1 @@ -32,8 +32,6 @@ spec: image: gcr.io/heptio-images/ark:latest command: - /ark - - --namespace - - heptio-ark args: - server envFrom: diff --git a/examples/common/00-prereqs.yaml b/examples/common/00-prereqs.yaml index 843e043e6..02dea4b5d 100644 --- a/examples/common/00-prereqs.yaml +++ b/examples/common/00-prereqs.yaml @@ -93,18 +93,12 @@ kind: Namespace metadata: name: heptio-ark ---- -apiVersion: v1 -kind: Namespace -metadata: - name: heptio-ark-server - --- apiVersion: v1 kind: ServiceAccount metadata: name: ark - namespace: heptio-ark-server + namespace: heptio-ark labels: component: ark @@ -117,7 +111,7 @@ metadata: component: ark subjects: - kind: ServiceAccount - namespace: heptio-ark-server + namespace: heptio-ark name: ark roleRef: kind: ClusterRole diff --git a/examples/common/10-deployment.yaml b/examples/common/10-deployment.yaml index 633a189b1..70d28566f 100644 --- a/examples/common/10-deployment.yaml +++ b/examples/common/10-deployment.yaml @@ -16,7 +16,7 @@ apiVersion: apps/v1beta1 kind: Deployment metadata: - namespace: heptio-ark-server + namespace: heptio-ark name: ark spec: replicas: 1 @@ -34,8 +34,6 @@ spec: - /ark args: - server - - --namespace - - heptio-ark volumeMounts: - name: cloud-credentials mountPath: /credentials diff --git a/examples/minio/00-minio-deployment.yaml b/examples/minio/00-minio-deployment.yaml index 9d10988ab..78a8ca233 100644 --- a/examples/minio/00-minio-deployment.yaml +++ b/examples/minio/00-minio-deployment.yaml @@ -16,7 +16,7 @@ apiVersion: apps/v1beta1 kind: Deployment metadata: - namespace: heptio-ark-server + namespace: heptio-ark name: minio labels: component: minio @@ -53,7 +53,7 @@ spec: apiVersion: v1 kind: Service metadata: - namespace: heptio-ark-server + namespace: heptio-ark name: minio labels: component: minio @@ -70,7 +70,7 @@ spec: apiVersion: v1 kind: Secret metadata: - namespace: heptio-ark-server + namespace: heptio-ark name: cloud-credentials labels: component: minio @@ -84,7 +84,7 @@ stringData: apiVersion: batch/v1 kind: Job metadata: - namespace: heptio-ark-server + namespace: heptio-ark name: minio-setup labels: component: minio diff --git a/examples/minio/10-ark-config.yaml b/examples/minio/10-ark-config.yaml index f46ef83b6..76d0c6c57 100644 --- a/examples/minio/10-ark-config.yaml +++ b/examples/minio/10-ark-config.yaml @@ -24,7 +24,7 @@ backupStorageProvider: config: region: minio s3ForcePathStyle: "true" - s3Url: http://minio.heptio-ark-server.svc:9000 + s3Url: http://minio.heptio-ark.svc:9000 backupSyncPeriod: 1m gcSyncPeriod: 1m scheduleSyncPeriod: 1m