diff --git a/docs/ce/getting-started/with-opentofu.mdx b/docs/ce/getting-started/with-opentofu.mdx index ff9e0fa90..a2812fb12 100644 --- a/docs/ce/getting-started/with-opentofu.mdx +++ b/docs/ce/getting-started/with-opentofu.mdx @@ -236,7 +236,7 @@ Then you can add a comment like `digger apply` and shortly after apply output wi ## Demo repositories - +- [OpenTofu demo repo](https://github.com/diggerhq/demo-opentofu) - [AWS demo repo](https://github.com/diggerhq/quickstart-actions-aws) - [GCP demo repo](https://github.com/diggerhq/demo-conftest-gcp/) - [Azure demo repo](https://github.com/diggerhq/azure-onboarding-test) diff --git a/docs/ce/getting-started/with-terraform.mdx b/docs/ce/getting-started/with-terraform.mdx index 35b36ca07..a9ade1e04 100644 --- a/docs/ce/getting-started/with-terraform.mdx +++ b/docs/ce/getting-started/with-terraform.mdx @@ -5,7 +5,7 @@ title: "With Terraform" In this tutorial, you will set up Digger to automate terraform pull requests using Github Actions **Prerequisites** -- A GitHub repository with valid terraform code +- A GitHub repository with valid terraform code, don't have one? see [here](#demo-repositories) - Your cloud provider credentials: - For AWS: [Hashicorp's AWS tutorial](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/aws-build) - For GCP: [Hashicorp's GCP tutorial](https://developer.hashicorp.com/terraform/tutorials/gcp-get-started/google-cloud-platform-build) @@ -16,7 +16,11 @@ In this tutorial, you will set up Digger to automate terraform pull requests usi Head to [ui.digger.dev](https://ui.digger.dev) and sign up using your preferred method. -You should see an empty dashboard after you sign up. +Post sign up, your dashboard should look like this: + +![](/images/readme/ui.digger.dev.png) + + @@ -40,10 +44,35 @@ In GitHub repository settings, go to Secrets and Variables - Actions. Create the - `AWS_ACCESS_KEY_ID` - `AWS_SECRET_ACCESS_KEY` You can also [use OIDC](/ce/cloud-providers/authenticating-with-oidc-on-aws) for AWS authentication. + + + From the repository root (with GitHub CLI installed): + + ```bash + # Set AWS credentials as repository Action secrets + gh secret set AWS_ACCESS_KEY_ID --body "$AWS_ACCESS_KEY_ID" + gh secret set AWS_SECRET_ACCESS_KEY --body "$AWS_SECRET_ACCESS_KEY" + ``` + - `GCP_CREDENTIALS` - contents of your GCP Service Account Key json file You can also [use OIDC](/gcp/federated-oidc-access/) for GCP authentication. + + + If your Service Account key is saved to a file, you can pipe it directly: + + ```bash + # Set GCP credentials secret from a JSON key file + gh secret set GCP_CREDENTIALS < path/to/service-account-key.json + ``` + + Or set from an environment variable/string: + + ```bash + gh secret set GCP_CREDENTIALS --body "$(cat path/to/service-account-key.json)" + ``` + - `AZURE_CLIENT_ID` - Your Azure App Registration Client ID @@ -51,6 +80,16 @@ In GitHub repository settings, go to Secrets and Variables - Actions. Create the - `AZURE_SUBSCRIPTION_ID` - Your Azure Subscription ID You'll need to configure OIDC authentication by setting up federated credentials in your Azure App Registration. See [Azure OIDC setup](/ce/azure-specific/azure) for details. + + + From the repository root (with GitHub CLI installed): + + ```bash + gh secret set AZURE_CLIENT_ID --body "$AZURE_CLIENT_ID" + gh secret set AZURE_TENANT_ID --body "$AZURE_TENANT_ID" + gh secret set AZURE_SUBSCRIPTION_ID --body "$AZURE_SUBSCRIPTION_ID" + ``` + @@ -230,9 +269,19 @@ Terraform will run an existing plan against your code. Make any change to your terraform code e.g. add a blank line. An action run should start (you can see log output in Actions). After some time you should see output of Terraform Plan added as a comment to your PR. + +If you forked one of the demo repositories you will need to enable Actions in your repository. Then you can add a comment like `digger apply` and shortly after apply output will be added as comment too. - + + ## Demo repositories @@ -240,3 +289,5 @@ Then you can add a comment like `digger apply` and shortly after apply output wi - [AWS demo repo](https://github.com/diggerhq/quickstart-actions-aws) - [GCP demo repo](https://github.com/diggerhq/demo-conftest-gcp/) - [Azure demo repo](https://github.com/diggerhq/azure-onboarding-test) + + diff --git a/docs/images/readme/digger-apply.gif b/docs/images/readme/digger-apply.gif new file mode 100644 index 000000000..b1e056669 Binary files /dev/null and b/docs/images/readme/digger-apply.gif differ diff --git a/docs/images/readme/ui.digger.dev.png b/docs/images/readme/ui.digger.dev.png new file mode 100644 index 000000000..661461edd Binary files /dev/null and b/docs/images/readme/ui.digger.dev.png differ diff --git a/docs/readme/introduction.mdx b/docs/readme/introduction.mdx index fd924cc6e..ff2b2fa2d 100644 --- a/docs/readme/introduction.mdx +++ b/docs/readme/introduction.mdx @@ -8,6 +8,21 @@ description: "Digger is an open-source CI/CD orchestrator for Terraform" - But then you end up duplicating your CI/CD infrastructure - compute, jobs, logs etc - And you need to give it admin access to your cloud accounts + + +## Want to get started quickly? + + +

+ Get started with Digger in minutes. +

+ + + + + + + ## Run Terraform in your CI Digger spins up jobs in your existing CI instead of running its own CI-like infrastructure. This is: diff --git a/docs/videos/apply.mp4 b/docs/videos/apply.mp4 new file mode 100644 index 000000000..4d6e46ce4 Binary files /dev/null and b/docs/videos/apply.mp4 differ