3.7 KiB
Run Ark on GCP
You can run Kubernetes on Google Cloud Platform in either of:
- Kubernetes on Google Compute Engine virtual machines
- Google Kubernetes Engine
If you do not have the gcloud
and gsutil
CLIs locally installed, follow the user guide to set them up.
Create GCS bucket
Heptio Ark requires an object storage bucket in which to store backups. Create a GCS bucket, replacing placeholder appropriately:
gsutil mb gs://<YOUR_BUCKET>/
Create service account
To integrate Heptio Ark with GCP, create an Ark-specific Service Account:
-
View your current config settings:
gcloud config list
Store the
project
value from the results in the environment variable$PROJECT_ID
. -
Create a service account:
gcloud iam service-accounts create heptio-ark \ --display-name "Heptio Ark service account"
Then list all accounts and find the
heptio-ark
account you just created:gcloud iam service-accounts list
Set the
$SERVICE_ACCOUNT_EMAIL
variable to match itsemail
value. -
Attach policies to give
heptio-ark
the necessary permissions to function:BUCKET=<YOUR_BUCKET> ROLE_PERMISSIONS=( compute.disks.get compute.disks.create compute.disks.createSnapshot compute.snapshots.get compute.snapshots.create compute.snapshots.useReadOnly compute.snapshots.delete compute.projects.get ) gcloud iam roles create heptio_ark.server \ --project $PROJECT_ID \ --title "Heptio Ark Server" \ --permissions "$(IFS=","; echo "${ROLE_PERMISSIONS[*]}")" gcloud projects add-iam-policy-binding $PROJECT_ID \ --member serviceAccount:$SERVICE_ACCOUNT_EMAIL \ --role projects/$PROJECT_ID/roles/heptio_ark.server gsutil iam ch serviceAccount:$SERVICE_ACCOUNT_EMAIL:objectAdmin gs://${BUCKET}
-
Create a service account key, specifying an output file (
credentials-ark
) in your local directory:gcloud iam service-accounts keys create credentials-ark \ --iam-account $SERVICE_ACCOUNT_EMAIL
Credentials and configuration
If you run Google Kubernetes Engine (GKE), make sure that your current IAM user is a cluster-admin. This role is required to create RBAC objects. See the GKE documentation for more information.
In the Ark root directory, run the following to first set up namespaces, RBAC, and other scaffolding. To run in a custom namespace, make sure that you have edited the YAML files to specify the namespace. See Run in custom namespace.
kubectl apply -f examples/common/00-prereqs.yaml
Create a Secret. In the directory of the credentials file you just created, run:
kubectl create secret generic cloud-credentials \
--namespace <ARK_NAMESPACE> \
--from-file cloud=credentials-ark
Specify the following values in the example files:
-
In file
examples/gcp/00-ark-config.yaml
:- Replace
<YOUR_BUCKET>
. See the Config definition for details.
- Replace
-
(Optional) If you run the nginx example, in file
examples/nginx-app/with-pv.yaml
:- Replace
<YOUR_STORAGE_CLASS_NAME>
withstandard
. This is GCP's defaultStorageClass
name.
- Replace
Start the server
In the root of your Ark directory, run:
kubectl apply -f examples/gcp/00-ark-config.yaml
kubectl apply -f examples/gcp/10-deployment.yaml