actions

KO | EN

gitlite — search

#hacktoberfest #react #typescript #go #golang #android #deep-learning #nodejs #windows #cli #kubernetes #vue #openai #ios

(★ 10)

Shared Github Actions for common situations.

actions Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Duplo Setup Action

An Action to set up duplocloud cli and the underlying cloud. During this process, duplo discovers the underlying cloud which is either aws, gcp, or azure. Once the cloud is known, the corresponding cli is installed. Finally the action will authenticate with the cloud provider.
It provides the following features:

- Setting up Python.
- Installing `duploctl`.
- when AWS
  - Installing AWS CLI.
  - Running Duplo JIT (Just-In-Time) for AWS.
  - Configuring AWS IAM Credentials.
- when GCP
  - Installing GCP CLI.
  - Running Duplo JIT (Just-In-Time) for GCP.
  - Configuring GCP SA Credentials.
- when Azure
  - Installing Azure CLI.
  - Configuring Azure SCP Credentials.

## Inputs

The following input variables can be configured:

| Name              | Description                                                                 | Required | Default Value |
|-------------------|-----------------------------------------------------------------------------|----------|---------------|
| `mask-account-id` | Mask AWS Account ID in logs                                                 | `false`  | `false`       |
| `region`          | Overide the cloud region from the default. For gcp this is required.        | `false`  |               |
| `account-id`      | Overide the cloud account id from the default. Required when on gcp/azure where this would be the project name or directory name. | `false`  |               |
| `credentials`     | Cloud credentials for Azure or GCP. Leave this null for gcp jit                                        | `false`  |               |
| `version`        | Duplo version to install.                                                    | `false`  | `latest`      |
| `jit`             | Enable JIT (Just-In-Time) authentication for cloud providers.               | `false`  | `true`        |
| `cloud-cli`       | Enable cloud CLI installation and configuration (AWS CLI, gcloud, Azure CLI). | `false`  | `true`        |

## Usage

**JIT for AWS/GCP Example:**  
```yaml
name: Quick Setup
on: 
- push
jobs:
  build:
    runs-on: ubuntu-latest
    env:
      DUPLO_TOKEN: ${{ secrets.DUPLO_TOKEN }}
      DUPLO_HOST: ${{ vars.DUPLO_HOST  }}
      DUPLO_TENANT: ${{ vars.DUPLO_TENANT }}
    steps:
    - name: Duplo Setup
      uses: duplocloud/actions@<VERSION OF THIS ACTION>
      with:
        version: <DUPLOCTL VERSION>
```

**GCP or Azure Example with Credentials:**  
This uses given credentials to setup GCP or Azure. The name of the account is required for GCP and Azure as well. For GCP the account is the project id and for Azure it is the directory id.   
```yaml
steps:
- name: Duplo Setup
  uses: duplocloud/actions@<VERSION OF THIS ACTION>
  with:
    account-id: ${{ vars.CLOUD_ACCOUNT }}
    credentials: ${{ secrets.CLOUD_CREDENTIALS }}
    version: <DUPLOCTL VERSION>
```

## Authentication

Each underlying cloud has their own unique way of authenticating.

### AWS

Using the JIT functionality built into the portal, the action uses retreives an sts session from the duplo portal and uses these credentials to authenticate with the AWS CLI. Magical.

### Azure

The action uses the `azure/login` action to authenticate with Azure. To keep things consistent this action will use the `CLOUD_CREDENTIALS` secret to authenticate which expects the following format:  
```json
{
  "clientId": "<client-id>",
  "clientSecret": "<client-secret>",
  "subscriptionId": "<subscription-id>",
  "tenantId": "<tenant-id>"
}
```

### GCP

When no credentials are given, duploctl will run the JIT command for GCP and configure the GCP environment. The action uses the `google-github-actions/setup-gcloud` action to authenticate with GCP when credentials are given. To keep things consistent this action will use the `CLOUD_CREDENTIALS` secret to authenticate which expects the following format:  
```json
{
  "type": "service_account",
  "project_id": "<project-id>",
  "private_key_id": "<private-key-id>",
  "private_key": "<private-key>",
  "client_email": "<client-email>",
  "client_id": "<client-id>",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://accounts.google.com/o/oauth2/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "<client-x509-cert-url>"
}
```

## Contained Actions

This repo is a mono repo for a number of useful actions. The main action is the `setup` action. Once all the tools are installed by running the setup action, the other actions can be used.

### [duplocloud/actions/update-image](./update-image)  
This action is used to update the image of a service in Duplo. It is a simple action that takes the service name and the image name as inputs.

### [duplocloud/actions/build-image](./build-image)  
A wrapper for the `docker build` or `buildx` command. This action is used to build a docker image and push it to a registry.

### [duplocloud/actions/setup-terraform](./setup-terraform)  
This action is used to install the necessary dependencies for working with Terraform. It supports caching of Terraform and TFLint plugins to improve performance.

### [duplocloud/actions/terraform-module](./terraform-module)  
Sets up a Terraform module for use in a GitHub Action.

### [duplocloud/actions/terraform-exec](./terraform-exec)  
Runs plan/apply/destroy on a Terraform module.

### [duplocloud/actions/terraform-import](./terraform-import)  
Import a list resources into a Terraform state file.

### [duplocloud/actions/k8s-job](./k8s-job)  
Import a list resources into a Terraform state file.

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE).

## References

- Third Party Actions: 
   - [actions/cache@v5](https://github.com/actions/cache)
   - [actions/create-github-app-token@v3](https://github.com/actions/create-github-app-token)
   - [actions/setup-python@v6](https://github.com/actions/setup-python)
   - [actions/upload-artifact@v7](https://github.com/actions/upload-artifact)
   - [aws-actions/amazon-ecr-login@v2](https://github.com/aws-actions/amazon-ecr-login)
   - [aws-actions/configure-aws-credentials@v6](https://github.com/aws-actions/configure-aws-credentials)
   - [azure/CLI@v3](https://github.com/marketplace/actions/azure-cli-action)
   - [azure/login@v3](https://github.com/azure/login)
   - [crazy-max/ghaction-github-runtime@v4](https://github.com/crazy-max/ghaction-github-runtime)
   - [docker/login-action@v4](https://github.com/docker/login-action)
   - [docker/setup-buildx-action@v4](https://github.com/docker/setup-buildx-action)
   - [docker/setup-qemu-action@v4](https://github.com/docker/setup-qemu-action)
   - [google-github-actions/auth@v3](https://github.com/google-github-actions/auth)
   - [google-github-actions/setup-gcloud@v3](https://github.com/google-github-actions/setup-gcloud)
   - [hashicorp/setup-terraform@v4](https://github.com/hashicorp/setup-terraform)
   - [terraform-linters/setup-tflint@v6](https://github.com/terraform-linters/setup-tflint)
   - [unfor19/install-aws-cli-action@v1](https://github.com/unfor19/install-aws-cli-action)

actions

actions Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

actions

actions Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README