Skip to content
DOCS
User Guide CLI Guide API Guide

Deploy Aembit Edge CLI with GitLab Jobs

This page describes how to use the Aembit Edge CLI in GitLab Jobs.

The Aembit Edge CLI provides the credentials get command to retrieve credentials from your Aembit Tenant. It simplifies the process of integrating Aembit Edge with GitLab Jobs by providing a command-line interface that handles the authentication and credential retrieval process.

Configure an Access Policy

Section titled “Configure an Access Policy”

To configure your Aembit Tenant to support GitLab Jobs as a Client Workload:

  1. Configure your Client Workload to identify the Aembit Edge CLI runtime environment with one or more of the following Client Workload Identifiers:

  2. Configure your Trust Provider type to Gitlab Job ID Token to identify and attest the Aembit Edge CLI runtime environment.

    Make sure to copy the provided Edge SDK Client ID and any Audience values for configuration of the Aembit Edge CLI parameters.

  3. Configure your Credential Provider to specify the credential values which you want to be available in the CI runtime environment.

    You can use any Credential Provider type. Some may require specifying the --credential_names parameter when running the Aembit Edge CLI.

  4. Configure your Server Workload to specify the service endpoint host and port which you want to use in the CI runtime environment.

    You can use any Server Workload type. The --server_workload_host and --server_workload_port parameters must match the values you specify in the Server Workload configuration.

  5. Configure your Access Policy and then click Save & Activate.

Configure a custom Resource Set

Section titled “Configure a custom Resource Set”

To configure a GitLab Job to work with a custom Resource Set:

  1. Open your existing GitLab CI configuration file.

  2. Go to your Aembit Tenant, click the Trust Providers link in the left sidebar and locate your GitLab Trust Provider in the custom Resource Set you are working with.

  3. In your gitlab-ci.yml file, either:

    • update the AEMBIT_CLIENT_ID and add the AEMBIT_RESOURCE_SET_ID environment variables if you moving to a custom Resource Set; or
    • add both AEMBIT_CLIENT_ID and AEMBIT_RESOURCE_SET_ID environment variables if you are just getting started with enabling your workload to use Aembit.

    In the following example, see the AEMBIT_CLIENT_ID and AEMBIT_RESOURCE_SET_ID environment variables in the variables section.

    gitlab-ci.yml
        variables:
            AEMBIT_CLIENT_ID: aembit:stack:tenant:identity:gitlab_idtoken:uuid
            AEMBIT_RESOURCE_SET_ID: bd886157-ba1d-54x86-9f26-3095b0515278

  4. Verify these environment variables match the values in your Resource Set and Trust Provider in your Aembit Tenant.

  5. Commit your changes to the GitLab CI configuration file, .gitlab-ci.yml.

Using the Aembit Edge CLI

Section titled “Using the Aembit Edge CLI”

Please review the CLI Reference to review use of the CLI. A GitLab Job specific example is provided below.

Deploy the CI Script

Section titled “Deploy the CI Script”

  1. Retrieve the latest available Aembit Edge CLI Releases.

  2. Include Aembit Edge CLI within your CI environment. You do this by bundling it within an image or retrieving it dynamically as appropriate for your workload.

  3. Configure your CI script to call Aembit Edge CLI with the proper parameters. The following shows an example gitlab-ci.yml configuration for a GitLab Job:

    sample:
        variables:
            # Set this to the value of "Edge SDK Client ID" that is provided in the settings of your Trust Provider.
            AEMBIT_CLIENT_ID: aembit:stack:tenant:identity:gitlab_idtoken:uuid
            # Add AEMBIT_RESOURCE_SET_ID if using a Custom Resource Set
            # Example: AEMBIT_RESOURCE_SET_ID: bd886157-ba1d-54x86-9f26-3095b0515278
            # AEMBIT_RESOURCE_SET_ID: <your_resource_set_id>
        id_tokens:
            GITLAB_OIDC_TOKEN:
                # Set this to the value of "Edge SDK Audience" that is provided in the settings for your Trust Provider.
                aud: https://tenant.id.stack.aembit.io
        script:
            # Following are samples for OAuth Client Credentials flow, API Key, and Username/Password Credential Provider Types
            # Please update the --server_workload_host and --server_workload_port values to match your target workloads
            # Use 'eval' explicitly to ensure the output (for example, 'export TOKEN=...') is executed as shell commands.
            - eval $(./aembit credentials get --id_token $GITLAB_OIDC_TOKEN --server_workload_host oauth.sample.com --server_workload_port 443)
            - echo "OAuth Token: $TOKEN"
            - eval $(./aembit credentials get --id_token $GITLAB_OIDC_TOKEN --server_workload_host apikey.sample.com --server_workload_port 443 --credential_names APIKEY)
            - echo "API Key Example: $APIKEY"
            - eval $(./aembit credentials get --id_token $GITLAB_OIDC_TOKEN --server_workload_host password.sample.com --server_workload_port 443 --credential_names USERNAME,PASSWORD)
            - echo "Username Password Example: $USERNAME -- $PASSWORD"

Verify Aembit Edge CLI

Section titled “Verify Aembit Edge CLI”

To verify the Aembit Agent release, follow these steps using the gpg and shasum commands. Select the tab that matches your operating system and architecture:

  1. Download the Aembit Agent release version from the Aembit Agent Releases page along with the matching checksum files.

    Alternatively, you can download these files using curl, swapping out the highlighted release version with the version you're verifying:

    Terminal window
    curl -O https://releases.aembit.io/agent/1.24.3328/linux/amd64/aembit_agent_cli_linux_amd64_1.24.3328.tar.gz
    curl -O https://releases.aembit.io/agent/1.24.3328/aembit_agent_cli_linux_amd64_1.24.3328.tar.gz.sha256
    curl -O https://releases.aembit.io/agent/1.24.3328/aembit_agent_cli_linux_amd64_1.24.3328.tar.gz.sha256.sig

  2. Import Aembit's public GPG key from Keybase into gpg:

    Terminal window
    curl "https://keybase.io/aembit/pgp_keys.asc" | gpg --import

  3. Verify Aembit Agent's checksum integrity and authenticity with gpg:

    Terminal window
    gpg --verify aembit_agent_cli_linux_amd64_1.24.3328.tar.gz.sha256.sig aembit_agent_cli_linux_amd64_1.24.3328.tar.gz.sha256

    If you don't have gpg installed, see Verifying Aembit binary release signatures prerequisites.

    Your output should look similar to the following and include the highlighted line:

    Terminal window
    gpg --verify aembit_agent_cli_linux_amd64_1.24.3328.tar.gz.sha256.sig aembit_agent_cli_linux_amd64_1.24.3328.tar.gz.sha256
    gpg: Signature made Wed Sep 18 10:13:57 2024 PDT
    gpg:                using RSA key EA3D8D2FDAC6BD8137163D00D655E64729BC67D7
    gpg: Good signature from "Aembit, Inc. <keybase@aembit.io>" [unknown]
    ...

    As long as you see Good signature..., you know that the checksum files are valid and authentic.

  4. Verify the integrity of the Aembit Agent file you downloaded using shasum:

    Terminal window
    shasum -a 256 aembit_agent_cli_linux_amd64_1.24.3328.tar.gz.sha256

    If shasum returns a match, you know the file is intact and matches Aembit's original. The long hex string is the SHA256 hash that both your file and the checksums file agree on. No output would mean the checksums don't match.