cloud-addons-action

GitHub action to authenticate and consume StackSpot Run Cloud Platform API to create Addon.

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, and generate new keys at https://stackspot.com/en/settings/access-token. The credential needs the role cloud_platform enables to successfully consume the API.

Note: You can generate an application.yaml file, directly on the StackSpot Portal.

Use Case 1

  steps:
      - name: Checkout repo
        uses: actions/[email protected]
      - name: Publish addon
        uses: stack-spot/cloud-addons-action@main
        id: publish
        with:
          CLIENT_REALM: ${{ secrets.CLIENT_REALM }}
          CLIENT_ID: ${{ secrets.CLIENT_ID }}
          CLIENT_KEY: ${{ secrets.CLIENT_KEY }}
          ADDON_FILE: ${{ github.workspace }}/stackspot/addon.yaml
          PARAMETERS: |
            PLACEHOLDER_1 >> VALUE_1
            PLACEHOLDER_2 >> VALUE_2
          VERBOSE: true

Use Case 2

  steps:
      - name: Checkout repo
        uses: actions/[email protected]
      - name: Publish addon
        uses: stack-spot/cloud-addons-action@main
        id: publish
        with:
          CLIENT_REALM: ${{ secrets.CLIENT_REALM }}
          CLIENT_ID: ${{ secrets.CLIENT_ID }}
          CLIENT_KEY: ${{ secrets.CLIENT_KEY }}
          ADDON_FILE: ${{ github.workspace }}/stackspot/addon.yaml
          VALUES_SCHEMA_JSON_FILE: ${{ github.workspace }}/path/to/values.schema.json
          PARAMETERS: |
            PLACEHOLDER_1 >> VALUE_1
            PLACEHOLDER_2 >> VALUE_2
          VERBOSE: true

---

▶️ Action Inputs

Field	Mandatory	Default Value	Observation
CLIENT_ID	YES	N/A	StackSpot Client ID.
CLIENT_KEY	YES	N/A	StackSpot Client KEY.
CLIENT_REALM	YES	N/A	StackSpot Client Realm.
ADDON_FILE	YES	N/A	StackSpot addon config file (generally in stackspot folder)
VALUES_SCHEMA_JSON_FILE	NO	N/A	Helm Chart values.schema.json file path with a properties field to be used as valuesSchema in the ADDON_FILE informed.
PARAMETERS	NO	N/A	Placeholder values to replace in ADDON_FILE
VERBOSE	NO	false	Whether to show extra logs during execution. (e.g: true).

---

License

Apache License 2.0