Skip to content

Commit

Permalink
feat: improved labs descriptions (#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
ElderMatt authored Nov 27, 2024
1 parent 782bcb3 commit 974e730
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 38 deletions.
24 changes: 11 additions & 13 deletions docs/for-devs/console/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ All Builds of the team are listed here.

![Team builds](../../img/team-builds.png)

| Property | Description |
| ------------- | --------------------------------------------------------------- |
| Name | The name of the build |
| Type | Type of the build. `buildpacks` or `docker` |
| Webhook url | The `copy to clipboard` webhook URL if a trigger is configured for the build |
| Tekton | Link to the `PipelineRun`` of the build in the Tekton dashboard |
| Repository | The `copy to clipboard` repository name of the image |
| Tag | The tag of the image |
| Status | The status of the Build. If the Build has failed. click on the Tekton link to see more details |
| Property | Description |
| ----------- | ---------------------------------------------------------------------------------------------- |
| Name | The name of the build |
| Type | Type of the build. `buildpacks` or `docker` |
| Webhook url | The `copy to clipboard` webhook URL if a trigger is configured for the build |
| Tekton | Link to the `PipelineRun`` of the build in the Tekton dashboard |
| Repository | The `copy to clipboard` repository name of the image |
| Tag | The tag of the image |
| Status | The status of the Build. If the Build has failed. click on the Tekton link to see more details |

## Create a build

Expand All @@ -36,7 +36,7 @@ The name of the build will be used for the registry name of the image (`harbor.<

2. (optional) Adjust the tag

The tag will be used to tag the image (`harbor.<domainSuffix>/team-name/build-name:tag`)
The tag will be used to tag the image (`harbor.<domainSuffix>/team-name/build-name:tag`)

Now choose the type of the build:

Expand Down Expand Up @@ -77,7 +77,7 @@ To see the more status details of the build, click on the `PipelineRun` link of

1. In the Console, click on `Apps` in the left menu and then open `Gitea`

2. In the top menu of Gitea, click on `Explore` and then on the `green` repo
2. In the top left menu of Gitea, click on `Explore` and then on the `green` repo

3. Go to `Settings` (top right) and then to `Webhooks`

Expand Down Expand Up @@ -122,5 +122,3 @@ Build can be restarted by changing the `tag` of the build or by restarting the p
tkn pipelines list
tkn pipeline start <pipeline-name> --use-pipelinerun <pipelinerun-name>
```


2 changes: 1 addition & 1 deletion docs/get-started/labs/auto-image-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Configure auto image updater
sidebar_label: Configure Auto Image Updater
---

When using the Workload feature to deploy Helm charts from the Catalog, then you can also use the `Auto image updater` feature to to automatically update the container images of Kubernetes workloads.
When using the Workload feature to deploy Helm charts from the Catalog, then you can also use the `Auto image updater` feature to automatically update the container images of Kubernetes workloads.

:::info
The image update feature is only supported in combination with a Helm chart stored in the Catalog.
Expand Down
7 changes: 2 additions & 5 deletions docs/get-started/labs/create-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Create projects
sidebar_label: Create Projects
---

A Project is a collection of a Build, a Workload and a Service. The benefit of using Projects is that you can create a Build, a Workload and a Service in one run. Projects are ideal for developers to run multiple code branches next to each other and automatically update the deployment based on a push. In this lab we are going to create a Project and see how everything now comes together is one simple form.
A Project is a collection consisting of a Build, a Workload and a Service. The benefit of using Projects is that you can create a Build, a Workload and a Service in one run. Projects are ideal for developers to run multiple code branches next to each other and automatically update the deployment based on a push. In this lab we are going to create a Project and see how everything now comes together is one simple form.

## Create a new Git repository

Expand Down Expand Up @@ -65,7 +65,7 @@ Also notice that the status of the Build shows an exclamation mark. This is beca

1. In the Console, click on `apps` the left menu and then open `Gitea`.

2. In the top menu of Gitea, click on `Explore` and then on the `nodejs-helloworld` repo.
2. In the top left menu of Gitea, click on `Explore` and then on the `nodejs-helloworld` repo.

3. Go to `Settings` (top right) and then to `Webhooks`.

Expand Down Expand Up @@ -106,6 +106,3 @@ When the state of the Workload becomes `Healthy`, the URL of the Service created
Check the URL again. After a couple of minutes you will see the following page:

![Hello World](../../img/hello-world-2.png)



26 changes: 14 additions & 12 deletions docs/get-started/labs/create-sealed-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,18 @@ In this lab we will create sealed secrets and see how to securely sensitive info

4. Select the secret type. In this lab we will create a secret of type `opaque`.

5. Add the secret `data`. Add the following key-value pairs:
5. Click on `Add Item` so you can fill in two key-value pairs

- `password=helloworld`
- `username=labs-user`
6. In the `Encrypted data` section. Add the following key-value pairs:

- `key=password value=helloworld`
- `key=username value=labs-user`

![Create sealed secret](../../img/create-sealed-secrets.png)

6. Click on `submit`.
7. Click on `submit`.

7. Click on `Deploy Changes`.
8. Click on `Deploy Changes`.

Note that the secret value will only be visible at the time of creation or once it has been successfully synchronized with the cluster.

Expand Down Expand Up @@ -54,16 +56,16 @@ data:
username: bGFicy11c2Vy
kind: Secret
metadata:
creationTimestamp: "2024-09-12T06:11:55Z"
creationTimestamp: '2024-09-12T06:11:55Z'
name: secret-credentials
namespace: team-labs
ownerReferences:
- apiVersion: bitnami.com/v1alpha1
controller: true
kind: SealedSecret
name: secret-credentials
uid: b9dc5d5c-9699-4efb-86a8-7bd1dd869318
resourceVersion: "357105"
- apiVersion: bitnami.com/v1alpha1
controller: true
kind: SealedSecret
name: secret-credentials
uid: b9dc5d5c-9699-4efb-86a8-7bd1dd869318
resourceVersion: '357105'
uid: 84dd34e1-2313-482d-b7de-e5d848675fb7
type: kubernetes.io/opaque
```
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/labs/expose-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Publicly expose workloads
sidebar_label: Expose Services
---

When you have deployed your application using the Workloads feature, you will probably like to expose it publicly. In this lab we'll create a Service to publicly expose your application. When you create a Service, the Istio virtual service and and ingress resource for your application will be created automatically.
When you have deployed your application using the Workloads feature, you will probably like to expose it publicly. In this lab we'll create a Service to publicly expose your application. When you create a Service, the Istio virtual service and ingress resource for your application will be created automatically.

## Create a Service

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/labs/trigger-builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Also notice that the status of the Build shows an exclamation mark. This is beca

1. In the Console, click on `apps` the left menu and then open `Gitea`.

2. In the top menu of Gitea, click on `Explore` and then on the `green` repo.
2. In the top left menu of Gitea, click on `Explore` and then on the `green` repo.

3. Go to `Settings` (top right) and then to `Webhooks`.

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/labs/use-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The `quickstart-redis` Helm chart can be used to create a Redis master-replica c

![catalog](../../img/catalog.png)

3. Click on the `k8s-deployment` template.
3. Click on the `Quickstart-k8s-deployment` template.

![catalog](../../img/catalog-2.png)

Expand Down
6 changes: 2 additions & 4 deletions docs/get-started/labs/using-argo-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In Argo CD, notice that an application specific to your team has already been se

![Argo CD Team Application Overview](../../img/argo-team-app.png)

After clicking on the app and selecting `APP DETAILS`, you'll find the `REPO URL`.
After clicking on the app and selecting `DETAILS` in the top left menu, you'll find the `REPO URL` in the `SUMMARY` section.

Return to the Console, select the Gitea app in the apps section. In Gitea you will see a repository titled `otomi/team-<name>-argocd`.

Expand All @@ -26,7 +26,7 @@ Return to the Console, select the Gitea app in the apps section. In Gitea you wi

Let's demonstrate the capabilities of Argo CD by adding some manifests to the repository:

1. Create a file named `deploy-nginx.yaml` in the repository.
1. Create a file named `deploy-nginx.yaml` in the repository `otomi/team-<name>-argocd`.
2. Insert the following contents into the file:

```yaml
Expand Down Expand Up @@ -79,5 +79,3 @@ Once you return to the Argo CD application, click on the `team<name>` applicatio
The application is set to sync automatically, so a manual `SYNC` is not required. Once ArgoCD completes the sync, the nginx deployment will appear as shown below:

![Syncing in ArgoCD](../../img/argo-team-sync.png)


0 comments on commit 974e730

Please sign in to comment.