From 82d63a70850066040d94b7222444ea1fdf48693a Mon Sep 17 00:00:00 2001 From: Maximilian Jugl Date: Wed, 6 May 2026 08:38:22 +0200 Subject: [PATCH] docs: update README --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bcbd1e1..5414f85 100644 --- a/README.md +++ b/README.md @@ -11,22 +11,10 @@ If you're using the [install-stackit-cli action](https://stackit-solutions.git.o You also require a STACKIT service account key. The key must be tied to a service account which has editor privileges on SKE resources. -In the following example, the service account key is provided to the runner as a base64-encoded secret. ```yaml - name: Install STACKIT CLI uses: https://stackit-solutions.git.onstackit.cloud/actions/install-stackit-cli@v1 -- name: Set up STACKIT service account - env: - SA_KEY_B64: ${{ secrets.STACKIT_SERVICE_ACCOUNT_KEY_B64 }} - run: | - set -eo pipefail - - TMP_SA_KEY_PATH="$(mktemp)" - echo "Writing STACKIT service account key to $TMP_SA_KEY_PATH" - - echo "$SA_KEY_B64" | base64 -d > "$TMP_SA_KEY_PATH" - echo "STACKIT_SERVICE_ACCOUNT_KEY_PATH=$TMP_SA_KEY_PATH" >> "$GITHUB_ENV" - name: Hibernate cluster uses: https://stackit-solutions.git.onstackit.cloud/actions/ske-operations@v1 with: @@ -34,6 +22,7 @@ In the following example, the service account key is provided to the runner as a region: eu01 project-id: 01234567-89ab-cdef-0123-456789abcdef cluster-name: foo-cluster + service-account-key: ${{ secrets.STACKIT_SERVICE_ACCOUNT_KEY }} ``` ## Inputs @@ -42,6 +31,12 @@ In the following example, the service account key is provided to the runner as a - `region` (Required): Data center region of SKE cluster. - `project-id` (Required): STACKIT project ID. - `cluster-name` (Required): Name of SKE cluster. +- `service-account-key` (Optional): JSON representation of STACKIT service account key. +- `service-account-key-file` (Optional): Path to STACKIT service account key file. - `timeout-seconds` (Optional): Time in seconds after which target state check fails. Default is `900`. - `interval-seconds` (Optional): Time in seconds between target state checks. Default is `5`. - `wait` (Optional): Wait until target state of operation has been reached. Default is `true`. + +> **Note:** Either `service-account-key` or `service-account-key-file` must be set. +> If neither is set, the action will fail. +> If both are set, then `service-account-key-file` will be used.