docs: wip

padok-team · Jul 19, 2024 · f5589bc · f5589bc
1 parent ce7280a
commit f5589bc
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 3 deletions.
diff --git a/docs/assets/demo/homepage.png b/docs/assets/demo/homepage.png
diff --git a/docs/assets/demo/logs.png b/docs/assets/demo/logs.png
diff --git a/docs/faq.md b/docs/faq.md
@@ -1 +1 @@
-# TODO - FAQ
+# TODO - FAQ
diff --git a/docs/guides/ui.md b/docs/guides/ui.md
@@ -1 +1,43 @@
-# TODO - UI Overview
+# UI Overview
+
+The Burrito UI is a web-based interface that allows you to view the state of your Terraform layers and resources, as well as the drift between the desired and actual state of your infrastructure.
+
+## Pre-requisites
+
+- A running Burrito installation
+
+## Accessing the UI
+
+The Burrito UI is accessible via a web browser. To access the UI, you need to expose the `burrito-server` service locally or on a public URL.
+
+## Features
+
+### Homepage
+
+The homepage displays a list of all the Terraform layers that have been added to Burrito. Each layer is displayed as a card with the following information:
+
+- Namespace
+- Repository
+- Branch
+- Code path
+- Last plan result
+- State (Error, Out-of-sync, OK)
+
+![Homepage](../assets/demo/homepage.png)
+
+### Terraform / Terragrunt logs
+
+Click on the layer card to view the Terraform or Terragrunt logs for that layer. You can explore previous runs and view the logs for each run. The maximum number of logs to keep is configurable.
+![Logs](../assets/demo/logs.png)
+
+A dedicated page for exploring the logs is also available.
+
+### More to come
+
+Burrito is under active development, and we are working on adding more features to the UI such as:
+
+- "Plan and apply" buttons
+- Notifications
+- User management
+- Pull request view
+  ... and more!
diff --git a/docs/operator-manual/datastore.md b/docs/operator-manual/datastore.md
@@ -27,7 +27,7 @@ config:
 
 ## Authentication
 
-The different cloud provider implementations rely on the default credentials chain of the cloud provider SDKs. Use annotations and labels on the Burrito resources to specify the credentials to use.
+The different cloud provider implementations rely on the default credentials chain of the cloud provider SDKs. Use annotations and labels on the service account associated to the datastore by updating the `datastore.serviceAccount.metadata` field to specify the credentials to use. (e.g. `iam.amazonaws.com/role` for AWS)
 
 ## Authorization