Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix settings and typos in docs #1597

Merged
merged 4 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/cli/automation/github-actions/deployment-workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to use Terramate to automate and orchestrate Terraform Deployments in GitHub Actions
description: Learn how to use Terramate to configure custom GitOps workflows to automate and orchestrate Terraform and OpenTofu Deploymnets in GitHub Actions.
outline: [2, 3]
description: Learn how to use Terramate to configure custom GitOps workflows to automate and orchestrate Terraform and OpenTofu Deployments in GitHub Actions.
---

# Run a Deployment in GitHub Actions
Expand All @@ -17,6 +16,8 @@ This drift check will be used to judge the health of the deployment even if the

## Deployment Blueprints

Create the following GitHub Actions configuration at `.github/workflows/deploy.yml`

::: code-group

```yml [ AWS + Terramate Cloud ]
Expand Down
10 changes: 5 additions & 5 deletions docs/cli/automation/github-actions/drift-check-workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to use Terramate to automate and orchestrate Terraform Drift Checks in GitHub Actions
description: Learn how to use Terramate to configure custom GitOps workflows to automate and orchestrate Terraform and OpenTofu Drift Checks in GitHub Actions.
outline: [2, 3]
---

# Run a Drfit Check in GitHub Actions
Expand All @@ -12,20 +11,22 @@ Search for `CHANGEME` to adjust needed credentials details for AWS and Google Cl

Drift Checks require action and protocolling the results, so Terramate Cloud support is required for those workflows at the moment.

The following workflows run every day at 2am.
The following workflows run every day at 2 am.

## Terramate Cloud support

When synchronizing drift checks to Terramate Cloud, the following fetures will support the team with handling drifts:
When synchronizing drift checks to Terramate Cloud, the following features will support the team with handling drifts:

- Get notified on new drifts via Slacks notifications.
- Get notified on new drifts via Slack notifications.
- Highlight and identify drifted stacks in the Stacks List and Dashboard
- See drift details without requiring your team to have elevated access to read the Terraform state or have access to read the cloud resources.
- Identify the time when a drift happened and how long a stack stayed in a drifted state.
- Create automation to reconcile a drift without human interaction using `--cloud-status` filter in Terramate CLI.

## Deployment Blueprints

Create the following GitHub Actions configuration at `.github/workflows/drift.yml`

::: code-group

```yml [ AWS + Terramate Cloud ]
Expand Down Expand Up @@ -148,5 +149,4 @@ jobs:
env:
GITHUB_TOKEN: ${{ github.token }}
```

:::
5 changes: 3 additions & 2 deletions docs/cli/automation/github-actions/preview-workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to use Terramate to automate and orchestrate Terraform Previews in GitHub Actions
description: Learn how to use Terramate to configure custom GitOps workflows to automate and orchestrate Terraform and OpenTofu Previews in GitHub Actions.
outline: [2, 3]
---

# Run a Preview in GitHub Actions
Expand All @@ -14,7 +13,7 @@ Search for `CHANGEME` to adjust needed credentials details for AWS and Google Cl

When synchronizing previews to Terramate Cloud previews will be synchronized with a detailed status and can be reviewed on a stack level.

The following actions also post back previews as GitHub comments. This will soon be taken care of by Terramate Cloud to fix some short-commings:
The following actions also post back previews as GitHub comments. This will soon be taken care of by Terramate Cloud to fix some short-comings:

- GitHub limits the size of a comment, so when creating large plans of many stacks, previews are truncated.
- Rate limits in GitHub sometimes prevent comments from being created.
Expand All @@ -29,6 +28,8 @@ Terramate Cloud will provide:

## Deployment Blueprints

Create the following GitHub Actions configuration at `.github/workflows/preview.yml`

::: code-group

````yml [ AWS + Terramate Cloud ]
Expand Down
42 changes: 9 additions & 33 deletions docs/cli/automation/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# title: Running Terramate in Automation
title: GitOps for infrastructure with Terramate and Terraform / OpenTofu
description: Learn how to automate and orchestrate Terraform and OpenTofu with Terramate and GitOps workflows in GitHub Actions, GitLab CI/CD, BitBucket Pipelines and others.
title: GitOps for infrastructure with Terraform
description: Learn how to automate and orchestrate Terraform and OpenTofu with Terramate and GitOps workflows in GitHub Actions, GitLab CI/CD, BitBucket Pipelines and any other CI/CD.
---

# Running Terramate in Automation
Expand All @@ -12,38 +12,14 @@ BitBucket Pipelines, Azure DevOps, and others for cost-effective Terraform and O
This enables you to automate the orchestration of your IaC stacks using GitOps workflows and comes with the following
benefits:

✨ **GitOps for infrastructure**

Move fast using a declarative, single source of truth with an auditable history and change management controls.
Be more productive and reliable. Provide a better Developer Experience by building on top of tools your team already knows.

✨ **Run in any existing CI/CD**

Terramate helps you to achieve the best automation and collaboration experience when working with Terraform and OpenTofu
in any CI/CD. This means you can reuse existing infrastructure, collaboration features, audit logs and security.

✨ **Design your workflows without limitations**

Configure limitless workflows. Whether you prefer merge-and-apply or apply-and-merge; we got you covered.

✨ **Integrate any existing tooling**

Integrate third-party toolings such as *Infracost*, *Trivy*, *terrascan*, *checkov*, *OPA*, *Kyverno*, *Sentinel* and
others into your workflows. Terramate allows you to integrate and run any tool.

✨ **Reduce execution time of existing pipelines**

Parallel runs and change detection allows orchestrating stacks containing changes only and running those in parallel.

✨ **No extra budget needed**

Enable cost-effective automation for IaC by integrating with your existing CI/CD instead of paying
- **GitOps for infrastructure**: Move fast using a declarative, single source of truth with an auditable history and change management controls. Be more productive and reliable. Provide a better Developer Experience by building on top of tools your team already knows.
- **Run in any existing CI/CD**: Terramate helps you to achieve the best automation and collaboration experience when working with Terraform and OpenTofu in any CI/CD. This means you can reuse existing infrastructure, collaboration features, audit logs and security.
- **Design your workflows without limitations**: Configure limitless workflows. Whether you prefer merge-and-apply or apply-and-merge; we got you covered.
- **Integrate any existing tooling**: Integrate third-party toolings such as *Infracost*, *Trivy*, *terrascan*, *checkov*, *OPA*, *Kyverno*, *Sentinel* and others into your workflows. Terramate allows you to integrate and run any tool.
- **Reduce execution time of existing pipelines**: Parallel runs and change detection allows orchestrating stacks containing changes only and running those in parallel.
- **No extra budget needed**: Enable cost-effective automation for IaC by integrating with your existing CI/CD instead of paying
for an additional and expensive platform.

✨ **Maximum Security**

Using your existing CI/CD limits the number of privileged platforms in your organization. There's no need to provide an
additional platform with access to your cloud accounts.
- **Maximum Security**: Using your existing CI/CD limits the number of privileged platforms in your organization. There's no need to provide an additional platform with access to your cloud accounts.

## Guides

Expand Down
9 changes: 7 additions & 2 deletions docs/cloud/dashboard/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Dashboard in Terramate Cloud
description: Learn how the dashboard in Terramate Cloud helps to keep an overview of the health of all stacks. In addition, it shows historical data about deployments.
---

# Dashboard

The dashboard helps to keep an overview of the health of all stacks. In addition, it shows historical data about deployments.
Expand All @@ -6,7 +11,7 @@ The dashboard helps to keep an overview of the health of all stacks. In addition

## Health Donut

The Health Donut either shows the amount of healthy stacks in case no stacks are unhealthy or the details about how many
The Health Donut either shows the number of healthy stacks in case no stacks are unhealthy or the details about how many
stacks are in a `failed` state and how many stacks are in a `drifted` state.

## Deployment Graph
Expand All @@ -16,7 +21,7 @@ stacks `failed` to deploy or succeeded.

## Last Deployments

To have a real time activity overview of deployments that were running or are currently running, the list of the last
To have a real-time activity overview of deployments that were running or are currently running, the list of the last
deployments shows details about deployment runs.

::: tip
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/deployments/synchronization-from-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ information to Terramate Cloud.
- `--cloud-sync-deployment` Synchronizes the deployment status and logs to Terramate Cloud
- `--cloud-sync-terraform-plan=FILE` A Terraform integration that allows synchronization of details about the changed, added or deleted Terraform Resources that were planned to be applied in the deployment

The full command line to run an auto approved apply based on an existing plan file in changed stacks only looks like the following:
The full command line to run an auto-approved apply based on an existing plan file in changed stacks only looks like the following:

```bash
terramate run \
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/drifts/notifications.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Drift Notifications
description: Learn how to get notified about new drifts that Terramate Cloud detects in stacks.
description: Learn how to configure Slack notifications for drift detection in Terramate Cloud.
---

# Drift Notifications
Expand All @@ -18,6 +18,6 @@ The notification will contain detailed information about the drifted stack and l

## Initial Drift Run

When on-boarding to Terramate Cloud it is recommended to run a drift run before setting up the notifications when the initial run is expected to detect a lot of drifted stacks.
When onboarding to Terramate Cloud it is recommended to run a drift run before setting up the notifications when the initial run is expected to detect a lot of drifted stacks.

After the initial drift check run, the Slack Webhook can be set up and only new drifts will notify the channel.
2 changes: 1 addition & 1 deletion docs/cloud/drifts/synchronization-in-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ To gather metadata from GitHub about the pull request associated with the previe
- Use OpenID Connect (OIDC) to authenticate to your Cloud Provider to use short-lived credentials - Terramate CLI uses OIDC by default.
- Ensure that all drift checks run on all stacks even if some errors are detected using the `--continue-on-error` command line option
- Run a Drift Check right after the deployment and synchronize the result to Terramate Cloud to get an immediate health check and ensure the deployment is stable.
- Run a Drift Check at least every 24h to get a detailed history about when drifts were introduced.
- Run a Drift Check at least every 24 hours to get a detailed history of newly detected drift.
- Set up notification to get informed about newly detected drifts in stacks
2 changes: 1 addition & 1 deletion docs/cloud/drifts/synchronization-with-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To gather metadata from GitHub about the commit associated with the drift check,

The following options are available in Terramate Scripts and mirror the CLI options with the name:

- Set `cloud_sync_drift_status = true` to let Terramate CLI know about the command that is doing the actual drift check and returns a detailed exit status to define a successful run that has changes or has no changed detected.
- Set `cloud_sync_drift_status = true` to let Terramate CLI know about the command that is doing the actual drift check and returns a detailed exit status to define a successful run that has changes or has no changes detected.
- Set `cloud_sync_terraform_plan_file` to the name of the terraform plan to synchronize the deployment details.

## Terramate Script Config
Expand Down
7 changes: 6 additions & 1 deletion docs/cloud/organization/user-management.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: User Management in Terramate Cloud
description: Learn how to manage users of an organization in Terramate Cloud.
---

# User Management

To manage teammates, an `admin` can choose from the following actions, while a normal `member` can only see the list of teammates or leave an organization.
Expand Down Expand Up @@ -44,7 +49,7 @@ Every teammate can decide to deactivate themselves to leave the organization.

As an `admin` you can promote other teammates by granting them the `admin` role or demote other teammates by granting them the `member` role.

Only other teammates can be managed this way. You can not demote yourself. To drop the `admin` role, promote another teammate to `admin` and ask the teammate to demote you. This guarantees that your organization always have at least one administrator.
Only other teammates can be managed this way. You can not demote yourself. To drop the `admin` role, promote another teammate to `admin` and ask the teammate to demote you. This guarantees that your organization always has at least one administrator.

In case the only teammate having an `admin` role is not active anymore, and you need to promote a new admin, please get in touch with our support.

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/previews/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Pull Requests and Previews
description: Learn how to synchronize pull reuest previews from CLI, automation or via Terramate Scripts, how to visualize Previews in Terramate Cloud.
description: Learn how to synchronize pull request previews from CLI, automation or via Terramate Scripts, how to visualize Previews in Terramate Cloud.
---

# Pull Requests and Previews
2 changes: 1 addition & 1 deletion docs/cloud/previews/synchronization-in-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ To gather metadata from GitHub about the pull request associated with the previe
- Use OpenID Connect (OIDC) to authenticate to your Cloud Provider to use short-lived credentials - Terramate CLI uses OIDC by default.
- Ensure that all drift checks run on all stacks even if some errors are detected using the `--continue-on-error` command line option
- Run a Drift Check right after the deployment and synchronize the result to Terramate Cloud to get an immediate health check and ensure the deployment is stable.
- Run a Drift Check at least every 24h to get a detailed history about when drifts were introduced.
- Run a Drift Check at least every 24 hours to get a detailed history of when drifts were introduced.
- Set up notifications to get informed about newly detected drifts in stacks
Loading