OpenSearch: 1. Create an access token and store it as a CI secret

This documentation is part of the GitHub Actions & GitLab CI guide. View the full guide here: Spin up a real OpenSearch service from your GitHub Actions or GitLab CI pipeline, run your tests against it, and tear it down automatically.

👋 Welcome to the Stackhero documentation!

Stackhero provides a fully managed OpenSearch cloud environment designed for both performance and security:

• High performance and strong security on a private, dedicated infrastructure.
• Use your own custom domain name, protected with HTTPS by default.
• Built-in OpenSearch Dashboards for easy data exploration and visualization.

Cut out setup and maintenance hassles: you can be up and running with OpenSearch cloud hosting from Stackhero in just a few minutes.

To enable the CLI to work non-interactively, you will need an access token (format: usr-xxxxxx:tokenId). You only need to create this token once and then add it to your CI pipeline as a secure, encrypted secret.

1. Create the token: In your Stackhero dashboard, click your profile picture at the top right, go to Your account, then Access tokens, and click Create token.
2. For GitHub Actions: In your repository, go to Settings > Secrets and variables > Actions > New repository secret, and enter the token as STACKHERO_TOKEN.
3. For GitLab CI: In your project, go to Settings > CI/CD > Variables > Add variable, set the key to STACKHERO_TOKEN, and check Masked (and Protected if your CI runs only on protected branches).

Do not include your access token directly in your pipeline YAML file. If it is present in YAML, it could be exposed to anyone with repository access and may appear in build logs. Storing it as a CI secret keeps it encrypted and masked, ensuring your token stays secure.