https://github.com/stack-spot/cloud-control-plane-bootstrap
Github Action to download Stackspot cloud control plane bootstrap module.
https://github.com/stack-spot/cloud-control-plane-bootstrap
all-os github-actions stackspot
Last synced: about 1 year ago
JSON representation
Github Action to download Stackspot cloud control plane bootstrap module.
- Host: GitHub
- URL: https://github.com/stack-spot/cloud-control-plane-bootstrap
- Owner: stack-spot
- Created: 2025-02-24T13:35:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-25T16:59:46.000Z (about 1 year ago)
- Last Synced: 2025-02-25T17:36:23.767Z (about 1 year ago)
- Topics: all-os, github-actions, stackspot
- Homepage: https://stackspot.com/
- Size: 16.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cloud-control-plane-bootstrap
Github Action to download Stackspot cloud control plane bootstrap terraform module.
_**Note**: This action is supported on all runners operating systems (`ubuntu`, `macos`, `windows`)_
## 📚 Usage
### Requirements
To get the account keys (`CLIENT_ID`, `CLIENT_KEY` and `CLIENT_REALM`), please login using a **ADMIN** user on the [StackSpot Portal](https://stackspot.com), and generate new keys at [https://stackspot.com/en/settings/access-token](https://stackspot.com/en/settings/access-token).
### Use Case
```yaml
steps:
- name: Checkout repository
uses: actions/checkout@v4.2.1
- name: Download control plane bootstrap ZIP file
uses: stack-spot/cloud-control-plane-bootstrap@v1
with:
CLIENT_KEY: ${{ secrets.CLIENT_KEY }}
CLIENT_ID: ${{ secrets.CLIENT_ID }}
CLIENT_REALM: ${{ secrets.CLIENT_REALM }}
VERSION: "latest" # Optional
```
After running the action, the control plane bootstrap ZIP file will then be available at path:
`$GITHUB_WORKSPACE/control_plane_bootstrap_${{ inputs.VERSION }}.zip`
_Example: $GITHUB_WORKSPACE/control_plane_bootstrap_latest.zip_
* * *
## ▶️ Action Inputs
Field | Mandatory | Default Value | Observation
------------ | ------------ | ------------- | -------------
**CLIENT_ID** | YES | N/A | [StackSpot](https://stackspot.com/en/settings/access-token) Client ID.
**CLIENT_KEY** | YES | N/A |[StackSpot](https://stackspot.com/en/settings/access-token) Client KEY.
**CLIENT_REALM** | YES | N/A |[StackSpot](https://stackspot.com/en/settings/access-token) Client Realm.
**VERSION** | NO | `latest` | Bootstrap version.
* * *
## License
[Apache License 2.0](https://github.com/stack-spot/cloud-deploy-action/blob/main/LICENSE)