<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.16 </button>

- [Latest version](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/latest/how-to/rotating-service-account-keys)
- [Version 1.16](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.16/how-to/rotating-service-account-keys.md.txt)
- [Earlier versions (unsupported)](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/latest/version-history#expandable-1)

<br />

This page describes how to rotate keys for the following service accounts:

- [Component access](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.16/how-to/service-accounts.md.txt#component_access_service_account)
- [Connect-register](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.16/how-to/service-accounts.md.txt#connect_register_service_account)
- [Logging-monitoring](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.16/how-to/service-accounts.md.txt#logging_monitoring_service_account)
- [Audit logging](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.16/how-to/service-accounts.md.txt#audit_logging_service_account)
- [Usage metering](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.16/how-to/service-accounts.md.txt#usage_metering_service_account)

To rotate your service account keys:

1. Create a directory to store a backup of your current secrets:

   ```
   mkdir backup
   ```
2. Note the following information for the relevant service account:

   **Component access**

   | Cluster | Secret | Namespace |
   |---|---|---|
   | Admin | admin-cluster-creds | kube-system |
   | Admin | user-cluster-creds | <var translate="no">CLUSTER_NAME</var>-gke-onprem-mgmt |
   | Admin | private-registry-creds | kube-system |
   | User | private-registry-creds | kube-system |

   - If you are not using a [private registry](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.16/how-to/admin-cluster-configuration-file.md.txt#privateregistry-section), the `private-registry-creds` Secret holds the key for your component access service account.
   - If you are using a private registry, the `private-registry-creds` Secret holds the credentials for your private registry, **not** the component access service account key.

   **Connect-register**

   | Cluster | Secret | Namespace |
   |---|---|---|
   | Admin | admin-cluster-creds | kube-system |
   | Admin | user-cluster-creds | <var translate="no">CLUSTER_NAME</var>-gke-onprem-mgmt |

   **Logging-monitoring**

   | Cluster | Secret | Namespace |
   |---|---|---|
   | Admin | admin-cluster-creds | kube-system |
   | Admin | user-cluster-creds | <var translate="no">CLUSTER_NAME</var>-gke-onprem-mgmt |
   | User | google-cloud-credentials | kube-system |
   | User | stackdriver-service-account-key | knative-serving |

   **Audit logging**

   | Cluster | Secret | Namespace |
   |---|---|---|
   | Admin | admin-cluster-creds | kube-system |
   | Admin | user-cluster-creds | <var translate="no">CLUSTER_NAME</var>-gke-onprem-mgmt |
   | Admin | kube-apiserver | <var translate="no">CLUSTER_NAME</var> |

   **Usage Metering**

   | Cluster | Secret | Namespace |
   |---|---|---|
   | Admin | user-cluster-creds | <var translate="no">CLUSTER_NAME</var>-gke-onprem-mgmt |
   | User | usage-metering-bigquery-service-account-key | kube-system |

   **Stackdriver**

   | Cluster | Secret | Namespace |
   |---|---|---|
   | Admin | admin-cluster-creds | kube-system |
   | Admin | user-cluster-creds | <var translate="no">CLUSTER_NAME</var>-gke-onprem-mgmt |
   | User | google-cloud-credentials | kube-system |
   | User | stackdriver-service-account-key | knative-serving |

3. Create a backup of each secret using the following command:

   ```
   kubectl get secret SECRET --namespace NAMESPACE \
       --kubeconfig KUBECONFIG -o json > backup/SECRET-NAMESPACE.json
   ```

   Replace the following:
   - `NAMESPACE`: the namespace where the secret is located. For example, `kube-system`.
   - `KUBECONFIG`: the path to the kubeconfig file for the admin or user cluster.
   - `SECRET`: the name of the secret. For example, `admin-cluster-creds`.

   For example, run the following commands for the audit logging service
   account:

   ```
   kubectl get secret admin-cluster-creds --namespace kube-system \
           --kubeconfig KUBECONFIG -o json > backup/admin-cluster-creds-kube-system.json

   kubectl get secret user-cluster-creds --namespace NAMESPACE \
           --kubeconfig KUBECONFIG -o json > backup/user-cluster-creds-NAMESPACE.json

   kubectl get secret kube-apiserver --namespace NAMESPACE \
           --kubeconfig KUBECONFIG -o json > backup/kube-apiserver-NAMESPACE.json
   ```
4. To create a new service account key file, run the following command:

   ```
   gcloud iam service-accounts keys create NEW_KEY_FILE --iam-account IAM_ACCOUNT
   ```

   Replace the following:
   - `NEW_KEY_FILE`: the name for your new service account key file
   - `IAM_ACCOUNT`: the email address of the service account
5. In the admin cluster configuration file, find the
   `componentAccessServiceAccountKeyPath` field, the `gkeConnect` section, the
   `stackdriver` section, and the `cloudAuditLogging` section. In those places,
   replace the paths to the service account key files.

6. In the user cluster configuration file, find the
   `componentAccessServiceAccountKeyPath` field, the `gkeConnect` section, the
   `stackdriver` section, the `cloudAudigLogging` section, and the
   `usageMetering` section. In those places, replace the paths to the service
   account key files.

7. Save the changes you made using the following commands:

   ```
   gkectl update credentials COMPONENT \
       --kubeconfig ADMIN_CLUSTER_KUBECONFIG \
       --config ADMIN_CLUSTER_CONFIG \
       --admin-cluster

   gkectl update credentials COMPONENT \
       --kubeconfig ADMIN_CLUSTER_KUBECONFIG \
       --config USER_CLUSTER_CONFIG
   ```

   Replace the following;
   - `COMPONENT`: one of `componentaccess`, `register`,
     `cloudauditlogging`, `usagemetering`, or `stackdriver`.

   - `ADMIN_CLUSTER_KUBECONFIG`: the path to the
     kubeconfig file for the admin cluster.

   - `ADMIN_CLUSTER_CONFIG`: the path to the admin
     cluster configuration file.

   - `USER_CLUSTER_CONFIG`: the path to the user
     cluster configuration file.

## Node re-creation

Some service account key rotations may take longer time because node
re-creation is required:

<br />

| **Service account** | **Nodes re-creation required** |
|---|---|
| Component access | If using Container Registry: Yes If using a private registry: No |
| Audit logging | Admin cluster: Yes User cluster with Contrlplane V2 enabled: Yes but only control plane nodes |
| Logging-monitoring | No |
| Connect-register | No |
| Usage metering | No |

<br />

## Restoring backups

If you need to restore the backups of the secrets you made earlier, run the
following command:

```
kubectl apply -f backup/
```