https://github.com/saladtechnologies/sce-deploy
https://github.com/saladtechnologies/sce-deploy
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/saladtechnologies/sce-deploy
- Owner: SaladTechnologies
- License: mit
- Created: 2024-04-15T20:12:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-22T03:15:12.000Z (about 1 year ago)
- Last Synced: 2025-04-18T08:39:43.432Z (6 months ago)
- Language: TypeScript
- Size: 935 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Automatically Deploy Containers to Salad's SCE
## Usage Example
Place the following in step in your github actions
```yml
- name: Deploy Update to SCE
uses: SaladTechnologies/sce-deploy@v0.1.1
with:
salad_organization:
salad_project:
salad_container_group:
salad_api_key: ${{secrets.SALAD_API_KEY}}
image_name:
```
## Requirements
- You must already have a Salad account with an existing container group. This
github action will simply update the image for the container group. All other
updates can be made using either the portal or the public API.
- You must get your Salad API key [here](https://portal.salad.com/api-key). It
is highly recommended to store this in Github as a secret (see example above).
## Setup Steps
1. Create a Salad account at https://portal.salad.com
2. Get the API key for your Salad account
[here](https://portal.salad.com/api-key)
3. Create a container group to configure hardware requirements, env vars...
4. Update the github action to include the salad organization, project &
container group
## Settings
Keys can be added directly to your .yml config file or referenced from your
project `Secrets` storage.
To add a `secret` go to the `Settings` tab in your project then select
`Secrets`. We strongly recommend you store your `password` as a secret.
| Key Name | Required | Example | Description |
| ----------------------- | -------- | -------------------------- | ------------------------------------------------------------------ |
| `salad_organization` | Yes | `salad` | The Salad organization name. Can be found in the portal url |
| `salad_project` | Yes | `production` | The Salad project name. Can be found in the portal url |
| `salad_container_group` | Yes | `my-container-group` | The Salad container group name. Can be found in the portal url bar |
| `salad_api_key` | Yes | `********` | The Salad API key |
| `image_name` | Yes | `ghcr.io/my-container:0.1` | The full image name, including registry, image name and tag |
| `aws_access_key_id` | NO | `********` | The AWS ECR Access key |
| `aws_secret_access_key` | NO | `********` | The AWS Secret Access Key associated with the Access Key Id |
## AWS ECR
```yml
- name: Deploy Update to SCE
uses: SaladTechnologies/sce-deploy@v0.1.1
with:
salad_organization:
salad_project:
salad_container_group:
salad_api_key: ${{secrets.SALAD_API_KEY}}
image_name:
aws_access_key_id: ${{secrets.AWS_ACCESS_KEY_ID}}
aws_secret_access_key: ${{secrets.AWS_SECRET_ACCESS_KEY}}
```