The update argument allows you to update an Astra resource, at this time only including:
$ actoolkit update -h
usage: actoolkit update [-h] {bucket,appVault,cloud,cluster,protection,schedule,replication,script} ...
options:
-h, --help show this help message and exit
objectType:
{bucket,appVault,cloud,cluster,protection,schedule,replication,script}
bucket (appVault) update bucket
cloud update cloud
cluster update cluster
protection (schedule)
update protection policy
replication update replication
script update script
The update bucket command allows you to update the credential of a managed bucket. The high level command usage is:
actoolkit update bucket <bucketID> <credentialGroupArgs>
The <bucketID> argument can be gathered from a list buckets command. The possible <credentialGroupArgs> are:
--credentialID/-c: the already existing credentialID, or--accessKeyand--accessSecret: to create a new credential which the bucket is then updated to use
Sample commands and output are as follows:
$ actoolkit update bucket 361aa1e0-60bc-4f1b-ba3b-bdaa890b5bac \
--credentialID ad0754c4-08dd-4b68-b478-b4d2456968d3
{"type": "application/astra-bucket", "version": "1.0", "id": "361aa1e0-60bc-4f1b-ba3b-bdaa890b5bac", "name": "astra-gcp-backup-fbe43be9aaa0", "state": "available", "credentialID": "ad0754c4-08dd-4b68-b478-b4d2456968d3", "provider": "gcp", "bucketParameters": {"gcp": {"bucketName": "astra-gcp-backup-fbe43be9aaa0"}}, "metadata": {"labels": [{"name": "astra.netapp.io/labels/internal/nautilusCreated", "value": "true"}], "creationTimestamp": "2022-04-28T19:05:53Z", "modificationTimestamp": "2023-02-07T19:03:21Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab"}}
$ actoolkit update bucket 266f3453-fef2-4f93-849b-a165a5625d25 \
--accessKey accessKey1234567890 --accessSecret accessSecret1234567890
{"type": "application/astra-credential", "version": "1.1", "id": "03851a0d-c8cb-4550-83da-40cde27e530a", "name": "mhaigh-test-bucket", "keyType": "s3", "valid": "true", "metadata": {"creationTimestamp": "2023-02-07T19:08:55Z", "modificationTimestamp": "2023-02-07T19:08:55Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab", "labels": [{"name": "astra.netapp.io/labels/read-only/credType", "value": "s3"}, {"name": "astra.netapp.io/labels/read-only/cloudName", "value": "s3"}]}}
{"type": "application/astra-bucket", "version": "1.1", "id": "266f3453-fef2-4f93-849b-a165a5625d25", "name": "mhaigh-test-bucket", "state": "available", "credentialID": "03851a0d-c8cb-4550-83da-40cde27e530a", "provider": "gcp", "bucketParameters": {"gcp": {"bucketName": "mhaigh-test-bucket"}}, "metadata": {"creationTimestamp": "2023-02-06T20:19:58Z", "modificationTimestamp": "2023-02-07T19:08:55Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab"}}
The update cloud command allows you to update the credential and/or default bucket of a cloud. The high level command usage is:
actoolkit update cloud <cloudID> <updateArg>
The <cloudID> argument can be gathered from a list clouds command. The other three possible arguments are:
To update the credentials of a cloud to a currently non-existing credential, use the --credentialPath argument to point at a local filesystem JSON credential object:
actoolkit update cloud <cloudID> --credentialPath path/to/credentials.json
This command first creates the credential object, and then updates the cloud to reference the new credential ID:
$ actoolkit update cloud 0ec2e027-80bc-426a-b844-692de243b29e -c ~/gcp-astra-demo-3d7d.json
{"type": "application/astra-credential", "version": "1.1", "id": "8e6c9667-f2f2-40c2-92d0-38467f7f45be", "name": "astra-sa@GCP", "keyType": "generic", "valid": "true", "metadata": {"creationTimestamp": "2023-02-06T19:54:32Z", "modificationTimestamp": "2023-02-06T19:54:32Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab", "labels": [{"name": "astra.netapp.io/labels/read-only/credType", "value": "service-account"}, {"name": "astra.netapp.io/labels/read-only/cloudName", "value": "GCP"}]}}
{"type": "application/astra-cloud", "version": "1.0", "id": "0ec2e027-80bc-426a-b844-692de243b29e", "name": "GCP", "state": "running", "stateUnready": [], "cloudType": "GCP", "credentialID": "8e6c9667-f2f2-40c2-92d0-38467f7f45be", "defaultBucketID": "361aa1e0-60bc-4f1b-ba3b-bdaa890b5bac", "metadata": {"labels": [], "creationTimestamp": "2022-04-26T01:53:06Z", "modificationTimestamp": "2023-02-06T19:54:33Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab"}}
To update the credentials of a cloud to a currently existing credential, use the --credentialID argument to reference an existing credentialID:
actoolkit update cloud <cloudID> --credentialID <credentialID>
The <credentialID> value can be gathered from a list credentials command.
$ actoolkit update cloud 0ec2e027-80bc-426a-b844-692de243b29e \
--credentialID 8e6c9667-f2f2-40c2-92d0-38467f7f45be
{"type": "application/astra-cloud", "version": "1.0", "id": "0ec2e027-80bc-426a-b844-692de243b29e", "name": "GCP", "state": "running", "stateUnready": [], "cloudType": "GCP", "credentialID": "8e6c9667-f2f2-40c2-92d0-38467f7f45be", "defaultBucketID": "361aa1e0-60bc-4f1b-ba3b-bdaa890b5bac", "metadata": {"labels": [], "creationTimestamp": "2022-04-26T01:53:06Z", "modificationTimestamp": "2023-02-08T13:48:23Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab"}}
To change a cloud's default bucket for backups, run the following command:
actoolkit update cloud <cloudID> --defaultBucketID <bucketID>
The <bucketID> can be gathered from a list buckets command (the bucket must already be under management).
$ actoolkit update cloud 0ec2e027-80bc-426a-b844-692de243b29e --defaultBucketID 361aa1e0-60bc-4f1b-ba3b-bdaa890b5bac
{"type": "application/astra-cloud", "version": "1.0", "id": "0ec2e027-80bc-426a-b844-692de243b29e", "name": "GCP", "state": "running", "stateUnready": [], "cloudType": "GCP", "credentialID": "8e6c9667-f2f2-40c2-92d0-38467f7f45be", "defaultBucketID": "361aa1e0-60bc-4f1b-ba3b-bdaa890b5bac", "metadata": {"labels": [], "creationTimestamp": "2022-04-26T01:53:06Z", "modificationTimestamp": "2023-02-06T20:24:53Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab"}}
The update cluster command allows you to update a cluster. The high level command usage is:
actoolkit update cluster <clusterID> <updateArg>
The <clusterID> argument can be gathered from a list clusters command. The available <updateArg> values are currently --credentialPath and --defaultBucketID, as detailed below.
The -p/--credentialPath argument allows for updating the kubeconfig credential of an existing cluster:
actoolkit update cluster <clusterID> --credentialPath path/to/kubeconfig
$ actoolkit update cluster 2d37cc47-f543-46a6-8895-2504b1a50ce2 --credentialPath ~/.kube/config
{"type": "application/astra-credential", "version": "1.1", "id": "f1bfe212-fb48-4f1f-9637-138efc04e788", "name": "aks-eastus-cluster", "keyType": "kubeconfig", "valid": "true", "metadata": {"creationTimestamp": "2023-03-07T20:17:21Z", "modificationTimestamp": "2023-03-07T20:26:48Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab", "labels": [{"name": "astra.netapp.io/labels/read-only/credType", "value": "kubeconfig"}, {"name": "astra.netapp.io/labels/read-only/cloudName", "value": "private"}, {"name": "astra.netapp.io/labels/read-only/clusterID", "value": "2d37cc47-f543-46a6-8895-2504b1a50ce2"}, {"name": "astra.netapp.io/labels/read-only/clusterName", "value": "aks-eastus-cluster"}]}}
To change or add a cluster's default bucket for backups and appVaults, run the following command:
actoolkit update cluster <clusterID> --defaultBucketID <bucketID>
The <bucketID> argument can be gathered from a list buckets command.
$ actoolkit update cluster d0e0767b-1d77-478d-8640-13272efe1e23 --defaultBucketID 78263925-c3b3-48af-97c9-32bc5bde3273
{"type": "application/astra-managedCluster", "version": "1.6", "id": "d0e0767b-1d77-478d-8640-13272efe1e23", "name": "uscentral1", "state": "running", "stateUnready": [], "managedState": "managed", "protectionState": "full", "protectionStateDetails": [], "restoreTargetSupported": "true", "snapshotSupported": "true", "managedStateUnready": [], "managedTimestamp": "2023-11-28T14:30:42Z", "inUse": "true", "clusterType": "gke", "clusterVersion": "1.27", "clusterVersionString": "v1.27.3-gke.100", "connectorCapabilities": ["relayV1", "watcherV1", "neptuneV1"], "namespaces": [], "defaultStorageClass": "274562c4-9fff-4051-b16b-9db6db60651b", "cloudID": "d1c502e6-d410-46fc-8c15-f67c5b63dea2", "credentialID": "dcf1c466-d0fe-4bdf-b3ba-6e0e6e0ae066", "isMultizonal": "false", "tridentManagedStateAllowed": ["unmanaged"], "tridentVersion": "23.10.0-test.6d2477dfad063cd2277395663d5b06d198365c9e+6d2477dfad063cd2277395663d5b06d198365c9e", "acpVersion": "23.10.0-test.6d2477dfad063cd2277395663d5b06d198365c9e+3670363ff598b0105b8b2735323d3c0ae3ccabb8", "privateRouteID": "b68aa04d-a787-483f-9d9e-7c2930981534", "apiServiceID": "727422d9-abca-45d6-876e-3a6c62ef5664", "defaultBucketID": "", "metadata": {"labels": [{"name": "astra.netapp.io/labels/read-only/cloudName", "value": "private"}], "creationTimestamp": "2023-11-28T14:30:42Z", "modificationTimestamp": "2023-11-28T15:41:36Z", "createdBy": "45347ae2-6a07-41b0-a544-674ac4317b87"}}
The update protection command allows you to update a protection policy. The high level command usage is:
actoolkit update protection <protectionID> <updateArgs>
The <protectionID> argument can be gathered from a list protections command. The available <updateArgs> values are (multiple can be specified with the same command):
-u/--bucketID: modify the bucket where the backups and snapshots are storagegrid-b/--backupRetention: modify the number of backups to retain-s/--snapshotRetention: modify the number of snapshots to retain-M/--dayOfMonth: modify the day of the month for the policy (only valid for monthly granularity)-W/--dayOfWeek: modify the day of the week for the policy (only valid for weekly granularity)-H/--hour: modify the hour of the policy (valid for all granularities except hourly)-m/--minute: modify the minute of the policy (valid for all granularities)
To update the bucket, run the following command:
$ actoolkit update protection 113a3140-e95d-42c9-be74-8cd169a65ae4 -u cdd3910c-6e37-4b91-beb2-57c6ed7dc7f3
{"type": "application/astra-schedule", "version": "1.3", "id": "113a3140-e95d-42c9-be74-8cd169a65ae4", "granularity": "hourly", "minute": "5", "snapshotRetention": "1", "backupRetention": "1", "bucketID": "cdd3910c-6e37-4b91-beb2-57c6ed7dc7f3"}
To modify the number of backups retained:
$ actoolkit update protection 8cfbd961-04b9-4f7f-a094-0542aaee8626 -b 3
{"type": "application/astra-schedule", "version": "1.3", "id": "8cfbd961-04b9-4f7f-a094-0542aaee8626", "granularity": "daily", "minute": "0", "hour": "2", "snapshotRetention": "1", "backupRetention": "3", "bucketID": "5f34da97-6195-4568-af77-52e01f9ae4bf"}
To modify the minute the policy is executed on:
$ actoolkit update protection 6967981a-cfe7-4b00-b38c-640f33223a48 -m 5
{"type": "application/astra-schedule", "version": "1.3", "id": "6967981a-cfe7-4b00-b38c-640f33223a48", "granularity": "weekly", "minute": "5", "hour": "2", "dayOfWeek": "0", "snapshotRetention": "1", "backupRetention": "1", "bucketID": "5f34da97-6195-4568-af77-52e01f9ae4bf"}
To modify the snapshot retention, hour, and minute of a policy:
$ actoolkit update protection a3f3d02a-6c22-4d62-9436-f678d271fdc5 -m 9 -H 6 -s 3
{"type": "application/astra-schedule", "version": "1.3", "id": "a3f3d02a-6c22-4d62-9436-f678d271fdc5", "granularity": "monthly", "minute": "9", "hour": "6", "dayOfMonth": "2", "snapshotRetention": "3", "backupRetention": "1", "bucketID": "5f34da97-6195-4568-af77-52e01f9ae4bf"}
The update replication command allows you to failover, reverse, or resync an existing replication policy. It is currently only supported for ACC environments. The high level command usage is:
actoolkit update replication <replicationID> <operation>
The <replicationID> argument can be gathered from a list replications command.
The <operation> keyword can be one of failover, reverse, or resync, as detailed below.
The failover operation stops the replication relationship and brings the app online on the destination cluster. This procedure does not stop the app on the source cluster if it was operational.
$ actoolkit update replication 5dbb4893-373d-46be-a5ec-cbdbf65ac673 failover
{"type": "application/astra-appMirror", "version": "1.0", "id": "5dbb4893-373d-46be-a5ec-cbdbf65ac673", "namespaceMapping": [{"clusterID": "0c00ddc3-4a80-45f9-8dd7-c8885153ad02", "namespaces": ["wordpress"]}, {"clusterID": "f3332e48-d175-4d6d-852f-bdee0f65a6fe", "namespaces": ["wordpress"]}], "state": "failingOver", "stateDesired": "failedOver", "stateDetails": [{"type": "https://astra.netapp.io/stateDetails/24", "title": "Snapshot replication completed", "detail": "A snapshot was replicated to the destination.", "additionalDetails": {"completionTime": "2022-09-20T18:07:03Z", "snapshotID": "037d315c-a40a-4e26-8624-1910f847137f", "startTime": "2022-09-20T18:05:43Z"}}], "transferState": "idle", "transferStateDetails": [], "healthState": "normal", "healthStateTransitions": [], "healthStateDetails": [], "metadata": {"labels": [], "creationTimestamp": "2022-09-19T19:09:32Z", "modificationTimestamp": "2022-09-20T18:58:31Z", "createdBy": "2b7a3f5e-c7da-4835-bfe2-6dd51c9b1444"}, "ReplicatedPVCs_": null}
Replication failover initiated
The resync operation re-establishes the replication relationship. You can choose which data to retain through the --dataSource/-s argument and either the clusterID or appID of the side you wish to use as the replication source.
This operation re-establishes the SnapMirror relationships to start the volume replication in the direction of choice. The process also stops the app on the new destination cluster before re-establishing replication.
$ actoolkit update replication 5dbb4893-373d-46be-a5ec-cbdbf65ac673 resync -s f3332e48-d175-4d6d-852f-bdee0f65a6fe
{"type": "application/astra-appMirror", "version": "1.0", "id": "5dbb4893-373d-46be-a5ec-cbdbf65ac673", "sourceAppID": "dbda1d21-76b2-4cad-bd92-f047e41453c7", "sourceClusterID": "f3332e48-d175-4d6d-852f-bdee0f65a6fe", "destinationAppID": "1be8daef-816e-4d17-a449-14b03639dcd1", "destinationClusterID": "0c00ddc3-4a80-45f9-8dd7-c8885153ad02", "namespaceMapping": [{"clusterID": "0c00ddc3-4a80-45f9-8dd7-c8885153ad02", "namespaces": ["wordpress"]}, {"clusterID": "f3332e48-d175-4d6d-852f-bdee0f65a6fe", "namespaces": ["wordpress"]}], "state": "establishing", "stateDesired": "established", "stateAllowed": ["established"], "stateDetails": [], "transferState": "idle", "transferStateDetails": [], "healthState": "normal", "healthStateTransitions": [], "healthStateDetails": [], "metadata": {"labels": [], "creationTimestamp": "2022-09-19T19:09:32Z", "modificationTimestamp": "2022-09-20T19:59:09Z", "createdBy": "2b7a3f5e-c7da-4835-bfe2-6dd51c9b1444"}, "ReplicatedPVCs_": null}
Replication resync initiated
The reverse operation moves the application to the destination cluster while continuing to replicate back to the original source cluster. Astra Control stops the application on the source cluster and replicates the data to the destination before failing over the app to the destination cluster.
In this situation, you are swapping the source and destination. The original source cluster becomes the new destination cluster, and the original destination cluster becomes the new source cluster.
$ actoolkit update replication 5dbb4893-373d-46be-a5ec-cbdbf65ac673 reverse
{"type": "application/astra-appMirror", "version": "1.0", "id": "5dbb4893-373d-46be-a5ec-cbdbf65ac673", "sourceAppID": "1be8daef-816e-4d17-a449-14b03639dcd1", "sourceClusterID": "0c00ddc3-4a80-45f9-8dd7-c8885153ad02", "destinationAppID": "dbda1d21-76b2-4cad-bd92-f047e41453c7", "destinationClusterID": "f3332e48-d175-4d6d-852f-bdee0f65a6fe", "namespaceMapping": [{"clusterID": "0c00ddc3-4a80-45f9-8dd7-c8885153ad02", "namespaces": ["wordpress"]}, {"clusterID": "f3332e48-d175-4d6d-852f-bdee0f65a6fe", "namespaces": ["wordpress"]}], "state": "establishing", "stateDesired": "established", "stateAllowed": ["established"], "stateDetails": [{"type": "https://astra.netapp.io/stateDetails/24", "title": "Snapshot replication completed", "detail": "A snapshot was replicated to the destination.", "additionalDetails": {"completionTime": "2022-09-20T20:07:05Z", "snapshotID": "1a5fc936-4f21-4e27-8081-d17155f50453", "startTime": "2022-09-20T20:05:44Z"}}], "transferState": "idle", "transferStateDetails": [], "healthState": "normal", "healthStateTransitions": [], "healthStateDetails": [], "metadata": {"labels": [], "creationTimestamp": "2022-09-19T19:09:32Z", "modificationTimestamp": "2022-09-20T20:18:44Z", "createdBy": "2b7a3f5e-c7da-4835-bfe2-6dd51c9b1444"}, "ReplicatedPVCs_": null}
Replication reverse initiated
The update script command allows you to update the source of an already existing script. The high level command usage is:
actoolkit update script <scriptID> <updatedScriptFilePath>
The <scriptID> argument can be gathered from a list scripts command.
Sample command and output are as follows:
$ actoolkit update script 282adc93-9df7-40e7-89d5-e120f525628d exampleScript.sh
{"metadata": {"labels": [], "creationTimestamp": "2023-02-08T21:31:30Z", "modificationTimestamp": "2023-02-08T21:32:08Z", "createdBy": "8146d293-d897-4e16-ab10-8dca934637ab"}, "type": "application/astra-hookSource", "version": "1.0", "id": "282adc93-9df7-40e7-89d5-e120f525628d", "name": "exampleScript", "private": "false", "preloaded": "false", "sourceType": "script", "source": "IyEvYmluL2Jhc2gKZWNobyAidGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUgdXBkYXRlIg==", "sourceMD5Checksum": "30978f9517ef027e7c6861e4cc1797ae"}