Skip to content
This repository has been archived by the owner on Mar 18, 2023. It is now read-only.

Commit

Permalink
Merge pull request #293 from stakater/update-tronador-docs
Browse files Browse the repository at this point in the history
Update tronador docs
  • Loading branch information
rasheedamir authored Mar 25, 2022
2 parents c0c2fb1 + 98cd300 commit 83194eb
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 4 deletions.
Binary file added content/sre/tronador/images/workflow-old.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/sre/tronador/images/workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions content/sre/tronador/images/workflow.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
title Tronador Workflow

actor Developer
participant Code Repo
participant Tekton
participant Image Registry
participant GitOps Repo
participant Argo
participant K8s Cluster
participant K8s Build
participant Tronador
participant Helm Controller
participant Tenant Operator
participant K8s Preview

Developer->Code Repo: git push
Developer->Code Repo: create pull request
Code Repo->Tekton: SCM event
Tekton->Image Registry: upload\nsnapshot image
note over Tekton: create EP CR
Tekton->GitOps Repo: push EP CR
Argo->GitOps Repo: git pull
Argo->K8s Cluster: sync
Tronador->K8s Cluster: watch EP
Tronador->+K8s Preview: create PR namespace
Tronador->K8s Preview: create helm release
Helm Controller->K8s Preview: watch helm release
K8s Build->K8s Preview: sync git secrets
Code Repo->K8s Preview: pull helm chart
Helm Controller->K8s Preview: create deployment
Tenant Operator->K8s Preview: sync image\nregistry secrets
Image Registry->K8s Preview: pull application snapshot image
note over K8s Preview: environment provisioning\n completed
5 changes: 4 additions & 1 deletion content/sre/tronador/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Troubleshooting

::: warning Note:

Please note: The guide below is written as a SAAP customer's point of view. If you use Tronador independently, the guide below might not be applicable to you. However, you can still use this guide to get an idea of how the process works.
The guide below is written as a SAAP customer's point of view. If you use Tronador independently, the guide below might not be applicable to you. However, you can still use this guide to get an idea of how the process works.

:::

## Developer support

Expand Down
10 changes: 7 additions & 3 deletions content/sre/tronador/workflow.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Workflow guide for Tronador

Please note: The guide below is written as a SAAP customer's point of view. If you use Tronador independently, the guide below might not be applicable to you. However, you can still use this guide to get an idea of how the process works.
::: warning Note:

The guide below is written as a SAAP customer's point of view. If you use Tronador independently, the guide below might not be applicable to you. However, you can still use this guide to get an idea of how the process works.

:::

For tronador to work, you need to add support for it in your Git Repository by adding a [Tronador config file](./config_file.html). Afterwards, a Tekton pipeline needs to be setup with the [Tronador cluster task](./cluster_task.html), and a cluster task that pushes the output EP to your gitops repository. Test environments should then be created automatically every time a PR is created or updated. The entire Dynamic Test Environment (DTE) creation process is described below.

Expand Down Expand Up @@ -180,8 +184,8 @@ status:

### Secrets management

Secrets for the helm chart to be deployed are currently passed along from the tronador config file, to the helm release. You can also use [Tenant Operator's](../tenant-operator/overview.html) [TemplateGroupInstance](../tenant-operator/customresources.html#_5-templategroupinstance) to pass secrets to the namespace that will be provisioned by the EnvironmentProvisioner by setting the proper label in your tronador config file.
Secrets for the helm chart to be deployed are currently passed along from the tronador config file, to the helm release. You can also use [Tenant Operator's](../tenant-operator/overview.html) [TemplateGroupInstance](../tenant-operator/customresources.html#_5-templategroupinstance) to pass secrets to the namespace that will be provisioned by the EnvironmentProvisioner by setting the proper label in your tronador config file. An example for this workflow is [provided here](../tenant-operator/usecases/deploying-templates.html#deploying-template-to-namespaces-via-templategroupinstances).

### Pods Deployed
### Application snapshot deployed

After the entire above process is completed, the Helm Release will create a deployment that will deploy the pods for the application and its changes mentioned in the PR to the namespace created by the Environment Provisioner.

0 comments on commit 83194eb

Please sign in to comment.