Skip to content

Commit 5996f13

Browse files
motatoesZIJ
andauthored
feat/new docs new (#2501)
* Bring back docs on local development * Improve local dev docs * Agent task for moving from callbacks to webhooks * Move from callback to webhooks, again * Make repos webhook async; dont comment erorr when installed to all repos * remove unecessary check * unnecessary comments * remove commented out code, ensure code parameter handled gracefully * fix error * ensure no unnecessary ai summaries generated * quickstart and intro --------- Co-authored-by: Igor Zalutski <[email protected]>
1 parent e6741f4 commit 5996f13

File tree

4 files changed

+47
-66
lines changed

4 files changed

+47
-66
lines changed

docs/docs.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222
"group": "Introduction",
2323
"pages": [
2424
"readme/introduction",
25-
"readme/howitworks",
26-
"readme/feedback"
25+
"readme/howitworks"
2726
]
2827
},
2928
{

docs/readme/feedback.mdx

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/readme/howitworks.mdx

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,39 @@
22
title: "How it works"
33
---
44

5-
Digger has 2 main components:
5+
Before OpenTaco the project was called digger and it consisted of purely a piece for PR automation. This engine was responsible for
6+
integrating with github actions and running CI jobs with terraform in response to certain events. We call this the PR Automation or "orchestrator" service.
67

7-
- A CLI agent that runs in your CI and interacts with Terraform CLI
8-
- An orchestrator backend that responds to events from GitHub and triggers CI jobs
8+
The same engine now became part of the OpenTaco suite and continues to be improved.
99

10-
When a PR is opened, Digger starts a CI job that runs `terraform plan` and posts plan output as comment. You can then comment "digger apply" to run `terraform apply`. Digger can also be configured to run apply only after the PR has been merged; to check plan output against OPA policies; to run drift detection on schedule; and so on.
10+
The OpenTaco architecture consists of these components:
1111

12-
The orchestrator backend does not have access to your cloud account, or terraform states, or plan output, or tfvars, or any other sensitive data. It just triggers CI jobs; your sensitive data never leaves the high-trust environment of your CI. For this reason, there is little reason to self-host the backend of Digger (although you still can). Much easier to use the managed cloud version of the orchestrator.
12+
- Statesman: Offers states management and remote runs capabilities
13+
- Drift: All drift detection capabilities including detection and remediation
14+
- Token: A token validation service (internal)
15+
- Orchestrator (formerly digger): Responsible for starting and stopping CI Jobs, currently responsible for all of PR automation.
16+
- UI: the UI layer, also acts as a gateway proxy to the other services
1317

14-
<Note>
15-
Digger can also run as a standalone GitHub Action without a backend. In this case:
16-
- comments and status checks will be updated with a delay
17-
- all applies will run sequentially in one job without concurrency
18-
- clashing applies from other jobs will fail as they cannot be queued
19-
- buckets / tables for PR-level locks need to be configured manually in your cloud account
20-
</Note>
18+
```mermaid
19+
flowchart LR
20+
subgraph Clients
21+
dev[Developer / User]
22+
end
23+
24+
subgraph OpenTaco
25+
ui[UI<br/>• Gateway proxy<br/>• Token validation]
26+
27+
subgraph Backend Services
28+
orch[Orchestrator<br/>• Start/stop CI jobs<br/>• PR automation]
29+
states[Statesman<br/>• State mgmt<br/>• Remote runs]
30+
drift[Drift<br/>• Drift detection<br/>• Remediation]
31+
end
32+
end
33+
34+
dev -->|HTTP / Browser| ui
35+
36+
%% Forward validated requests internally
37+
ui --> orch
38+
ui --> states
39+
ui --> drift
40+
```

docs/readme/introduction.mdx

Lines changed: 14 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,26 @@
11
---
2-
title: "About Digger"
3-
description: "Digger is an open-source CI/CD orchestrator for Terraform"
2+
title: "About OpenTaco"
3+
description: "OpenTaco is an all-in-one Toolkit for Terraform"
44
---
55

6-
- Unlike application code, terraform code has state. This makes CI/CD for it [painful](https://itnext.io/pains-in-terraform-collaboration-249a56b4534e)
7-
- You could use a dedicated CI like Terraform Cloud or Atlantis, known as [TACOs](https://itnext.io/spice-up-your-infrastructure-as-code-with-tacos-1a9c179e0783)
8-
- But then you end up duplicating your CI/CD infrastructure - compute, jobs, logs etc
9-
- And you need to give it admin access to your cloud accounts
10-
11-
12-
136
## Want to get started quickly?
147

15-
<Card title="Quick Start" icon="lightbulb" href="/ce/getting-started/with-terraform">
16-
<p>
17-
Get started with Digger in minutes.
18-
</p>
8+
<Card
9+
title="Quick Start"
10+
icon="lightbulb"
11+
href="/ce/getting-started/with-terraform"
12+
>
13+
<p>Get started with OpenTaco in minutes.</p>
1914
</Card>
2015

16+
## An All-in-One Terraform Toolkit
2117

18+
OpenTaco is a comprehensive solution that brings together everything you need to manage Terraform workflows effectively:
2219

20+
**State Management**: Built-in state management with RBAC, validation, and cross-account access. The state manager provides versioning and rollback capabilities.
2321

22+
**PR Automation**: Automatically run `terraform plan` on pull requests and post results as comments. Apply changes automatically within the PR, configure apply-on-merge workflows, and enforce approval requirements. OpenTaco handles PR-level locking to prevent conflicts between concurrent changes.
2423

24+
**Remote Runs**: Execute Terraform commands remotely and stream logs back to your terminal or CI system (using the TFE protocol)
2525

26-
## Run Terraform in your CI
27-
28-
Digger spins up jobs in your existing CI instead of running its own CI-like infrastructure. This is:
29-
- More scalable, because the on-demand compute of your CI is reused
30-
- More secure, because your sensitive data never leaves the CI job
31-
32-
## Compared to Atlantis
33-
- No need to host and maintain a server
34-
- Secure by design
35-
- Scalable compute with jobs isolation
36-
- Role-based access control via OPA
37-
38-
Read more about differences with Atlantis in our [blog post](https://medium.com/@DiggerHQ/digger-and-atlantis-key-differences-c08029ffe112)
39-
40-
## Compared to Terraform Cloud and other TACOs
41-
- Open source
42-
- No duplication of the CI/CD stack
43-
- Secrets not shared with a third party
44-
45-
## Support for other CI's
46-
47-
We are currently designing Digger to be Multi-CI, so that in addition to GitHub Actions, you can run Terraform/OpenTofu within other CI's such as Gitlab CI, Azure DevOps, Bitbucket, TeamCity, Circle CI and Jenkins, while still having the option to orchestrate jobs using Digger's [Orchestrator Backend](https://docs.digger.dev/self-host/deploy-docker).
48-
49-
Read more in this [blog](https://blog.digger.dev/how-we-are-designing-digger-to-support-multiple-ci-systems/), and please share your requirement on [Slack](https://bit.ly/diggercommunity) if you require support for other CI's. Your feedback/insight would help us a lot as this feature is in active development.
26+
**Drift Detection**: Continuously monitor your infrastructure for configuration drift. Schedule automated scans that detect changes and create GitHub issues for remediation.

0 commit comments

Comments
 (0)