Skip to content

Commit 138057f

Browse files
committed
Grammar and spelling fixes by Grammarly
1 parent 8478e54 commit 138057f

File tree

10 files changed

+73
-73
lines changed

10 files changed

+73
-73
lines changed

.markdownlint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"MD013" :false ,
2+
"MD013": false,
33
"MD033": {
44
"allowed_elements": ["details", "summary"]
55
}

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Whether you are a beginner looking to understand the basics or an experienced us
77
## About Argo CD
88

99
Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes.
10-
It allows for Kubernetes resources to be managed using git repositories as the source of truth, making it easier to implement continuous deployment strategies in cloud-native environments.
10+
It enables Kubernetes resources to be managed using Git repositories as the source of truth, making it easier to implement continuous deployment strategies in cloud-native environments.
1111
For more info on ArgoCD itself, please visit [their website](https://argoproj.github.io/cd/).
1212

1313
## Exercise list in order
@@ -25,7 +25,7 @@ It is recommended to follow the exercises in the following order.
2525
## Using this outside of the workshop
2626

2727
You need to have ArgoCD installed and running.
28-
All exercises should work on minikube, or kind.
28+
All exercises should work on minikube or kind.
2929
You can refer to the [installation link](https://argo-cd.readthedocs.io/en/stable/operator-manual/installation/) for how to install ArgoCD.
3030
You do not need the HA setup for the exercises.
3131

app-of-apps.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,31 @@
22

33
## Learning Goals
44

5-
- Create a bootstrap app manifest
5+
- Create a Bootstrap app manifest
66
- Arrange Argo CD app manifests in a folder structure
77

88
## Introduction
99

10-
In this exercise, we will work on organizing and managing Argo CD applications more effectively. We will create a bootstrap app manifest to serve as a starting point, structure our repository to accommodate multiple apps, and work with a new app manifest for a Helm chart.
10+
In this exercise, we will work on organizing and managing Argo CD applications more effectively. We will create a Bootstrap app manifest to serve as a starting point, structure our repository to accommodate multiple apps, and work with a new app manifest for a Helm chart.
1111

1212
## Exercise
1313

1414
### Overview
1515

1616
- Create Bootstrap App Manifest
17-
- Create Folder for All Apps
17+
- Create a folder for All Apps
1818
- Move Jenkins App Manifest
1919
- Create the App Manifest for the Quotes Helm Chart
2020

21-
### Step by step instructions
21+
### Step-by-step instructions
2222

2323
<details>
2424
<summary>More Details</summary>
2525

26-
- Create bootsrap app manifest
27-
- Create folder for all apps in the repo
26+
- Create Bootstrap app manifest
27+
- Create a folder for all apps in the repo
2828
- Move Jenkins app manifest to the folder
29-
- Create the app manifest for the quotes helm chart located in the same repo. (OR IN THE OTHER REPO TODO)
29+
- Create the app manifest for the quotes Helm chart located in the same repo. (OR IN THE OTHER REPO TODO)
3030
- Enable sync policy, prune and self-heal
3131
- kubectl delete parent app, make sure nothing is there. kubectl apply parent app again.
3232

@@ -68,7 +68,7 @@ kubectl apply -f bootstrap-app.yaml
6868

6969
1. Go to the Argo CD UI and verify that the bootstrap app is present. It should have an error saying that it cannot find the `apps` folder. This is expected.
7070

71-
## Step 2: Create Folder for All Apps, and add Jenkins App Manifest to it
71+
## Step 2: Create a folder for All Apps, and add Jenkins App Manifest to it
7272

7373
Save the current application manifest to your repository in a new folder named `apps`.
7474

@@ -117,11 +117,11 @@ spec:
117117
- Add, commit and push the jenkins-app.yaml to the repository.
118118
- Go to the Argo CD UI and verify that the bootstrap app is present. It should now be updated to include the `apps` folder, and therefore the Jenkins app manifest.
119119

120-
Now the jenkins app is connected with the bootstrap app.
120+
Now the Jenkins app is connected with the bootstrap app.
121121

122-
## Delete the jenkins app
122+
## Delete the Jenkins app
123123

124-
- In the Argo CD UI, delete the jenkins app.
124+
- In the Argo CD UI, delete the Jenkins app.
125125
- What happens when you do that?
126126

127127
## Create the App Manifest for the Quotes Helm Chart
@@ -161,7 +161,7 @@ spec:
161161

162162
1. Verify the applications are synced and running as expected.
163163

164-
1. Delete the bootstrap app from your cluster:
164+
1. Delete the Bootstrap app from your cluster:
165165

166166
```bash
167167
kubectl delete -f bootstrap-app.yaml
@@ -181,7 +181,7 @@ kubectl apply -f bootstrap-app.yaml
181181

182182
1. Verify the applications are synced and running as expected again.
183183

184-
You have now seen how fast it is to reapply your manifests to the cluster. This is a great way to recover from a disaster, or to make sure that your cluster is in the desired state.
184+
You have now seen how fast it is to reapply your manifests to the cluster. This is a great way to recover from a disaster or to make sure that your cluster is in the desired state.
185185

186186
</details>
187187

applicationsets.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
## Learning Goals
44

5-
- Trying out a pull request based application set
5+
- Trying out a pull-request based application set
66

77
## Introduction
88

9-
In this exercise we will try out a pull request based application set. We will try to create an application set that will create an application for each pull request in a repository.
9+
In this exercise, we will try out a pull-request based application set. We will try to create an application set that will create an application for each pull request in a repository.
1010

1111
## Application set
1212

1313
The sole responsibility of the ApplicationSet controller is to create, update, and delete `Application` resources within the Argo CD namespace. The controller's only job is to ensure that the Application resources remain consistent with the defined declarative ApplicationSet resource, and nothing more.
1414

15-
Thus the ApplicationSet controller does not create/modify/delete Kubernetes resources (other than the Application CR)
15+
Thus, the ApplicationSet controller does not create/modify/delete Kubernetes resources (other than the Application CR)
1616

1717
## Exercise
1818

1919
### Overview
2020

21-
- Create a github token
21+
- Create a GitHub token
2222
- Add the token to a secret in the argocd namespace
2323
- Create an applicationset manifest
2424
- Test with a pull request
2525
- Close the pull request
2626

27-
### Step by step instructions
27+
### Step-by-step instructions
2828

2929
<details>
3030
<summary>More Details</summary>
3131

32-
#### Create a github token
32+
#### Create a GitHub token
3333

34-
- Go to your github account settings and [create a new token](https://github.com/settings/tokens?type=beta) with the following permissions:
34+
- Go to your GitHub account settings and [create a new token](https://github.com/settings/tokens?type=beta) with the following permissions:
3535

3636
![github token permissions](img/github-token-permissions.png)
3737

@@ -80,12 +80,12 @@ spec:
8080
github:
8181
# The GitHub organization or user.
8282
owner: <YOUR GITHUB USERNAME> #e.g. eficode-academy
83-
# The Github repository
83+
# The GitHub repository
8484
repo: <YOUR GIT REPO> #Just the repository name e.g. argocd-katas. Not your entire URL
85-
tokenRef: # your github token
86-
secretName: student-<NUMBER>-github-token # the name of the secret that contains your github token
87-
key: token # the key in the secret that contains your github token
88-
# Labels is used to filter the PRs that you want to target. (optional)
85+
tokenRef: # your GitHub token
86+
secretName: student-<NUMBER>-github-token # the name of the secret that contains your GitHub token
87+
key: token # the key in the secret that contains your GitHub token
88+
# Labels are used to filter the PRs that you want to target. (optional)
8989
labels:
9090
- enhancement
9191
requeueAfterSeconds: 60
@@ -119,7 +119,7 @@ spec:
119119
selfHeal: true
120120
```
121121
122-
- take the contents of the file, and paste it into a file in your workstation. The file could be named ´appset.yaml´.
122+
- Copy the contents of the file and paste it into a file in your workstation. The file could be named ´appset.yaml´.
123123
- edit the file and replace
124124
- `<YOUR GITHUB USERNAME>` with your github username
125125
- `<YOUR GIT REPO>` with your git repo
@@ -212,7 +212,7 @@ Events: <none>
212212

213213
- Create a pull request in your git repo. The change does not matter at this time, since we are not using the source code in the pull request. 💡 The name of your branch needs to have all lowercase characters, otherwise it will not work.
214214

215-
- Remember to set the label `enhancement` on the pull request. The label does not exist, so create it in the Github UI.
215+
- Remember to set the label `enhancement` on the pull request. The label does not exist, so create it in the GitHub UI.
216216

217217
- Check that an application has been created in ArgoCD
218218

@@ -234,13 +234,13 @@ kubectl get ingress -n <YOUR NAMESPACE>
234234

235235
- Access the application in your browser (remember to add https:// in front of the hostname)
236236

237-
You should see something like the follwing:
237+
You should see something like the following:
238238

239239
![the todo application](img/todo-app.png)
240240

241241
#### Close the pull request
242242

243-
- now close the pull request, and see that the application is deleted from ArgoCD
243+
- Now, close the pull request, and see that the application is deleted from ArgoCD
244244

245245
```bash
246246
kubectl get applications -n argocd

argocd-and-helm.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Exercise: Deploying helm charts with Bitnami
1+
# Exercise: Deploying Helm charts with Bitnami
22

33
## Learning Goals
44

@@ -27,7 +27,7 @@ spec:
2727
destination:
2828
# The namespace the application should be deployed to.
2929
namespace: student-X
30-
# Specify the name of the destination cluster, either name or server url.
30+
# Specify the name of the destination cluster, either name or server URL.
3131
name: in-cluster
3232

3333
# Define the synchronization policy for the Application.
@@ -38,7 +38,7 @@ spec:
3838
sources:
3939
# Specify the repository URL for the Helm chart.
4040
- repoURL: 'https://charts.bitnami.com/bitnami'
41-
# Specify the target revision of the helm repository.
41+
# Specify the target revision of the Helm repository.
4242
targetRevision: 12.4.0
4343
# Specify the name of the Helm chart as "Jenkins".
4444
chart: jenkins
@@ -64,12 +64,12 @@ spec:
6464
6565
In this exercise, you will:
6666
67-
- Deploy Jenkins in the ArgoCD UI using Bitnami Helm chart.
67+
- Deploy Jenkins in the ArgoCD UI using the Bitnami Helm chart.
6868
- Change the source of the deployment file.
6969
- Write a multi-source deployment file.
7070
- Change the values in the deployment file for automatic changes to the Jenkins app.
7171
72-
### Step by Step Instructions
72+
### Step-by-Step Instructions
7373
7474
<details>
7575
<summary>More Details</summary>
@@ -111,7 +111,7 @@ We will change the values of the Jenkins deployment by using a values file. This
111111

112112
- Look at the `values.yaml` file in the `jenkins` directory. You can see that the `service.type` is set to `NodePort`, and two other values.
113113
- Now find the manifest in the ArgoCD UI by clicking on `app details`.
114-
- Change your manifest in ArgoCD in to use the `values.yaml` file by changing `source` to `sources` like the following:
114+
- Change your manifest in ArgoCD to use the `values.yaml` file by changing `source` to `sources` like the following:
115115

116116
``` yaml
117117
project: default
@@ -132,7 +132,7 @@ sources:
132132
ref: values
133133
```
134134

135-
💡 Remember to add your own repo to the file as well, as seen on the bottom. Pay attention to formatting.
135+
💡 Remember to add your repo to the file as well, as seen at the bottom. Pay attention to formatting.
136136

137137
- Click save.
138138

intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In this exercise, you will:
3131
- **Refresh**: This action updates the live view in ArgoCD with the current state of the cluster and the state of the git repo. It does not change any resources in the cluster.
3232
- **Sync**: This action deploys the desired state from the Git repository to the cluster. If there are differences between the Git repo and the cluster, Sync will make the necessary changes to align them.
3333

34-
### Step by Step Instructions
34+
### Step-by-Step Instructions
3535

3636
<details>
3737
<summary>More Details</summary>
@@ -148,4 +148,4 @@ postgres-7bc8b45445-kshd8 1/1 Running 1 20h
148148

149149
### Cleanup
150150

151-
Go ahead and delete the app in the ArgoCD UI. We will add it later as a true GitOps application
151+
Go ahead and delete the app in the ArgoCD UI. We will add it later as a true GitOps application.

projects.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Learning Goals
44

5-
- Introduction to the appproject manifest
6-
- Examine the restrictions you can make with the appprojects
5+
- Introduction to the app project manifest
6+
- Examine the restrictions you can make with the app projects
77

88
## Introduction
99

10-
Argo CD `projects` logically group applications for multiple teams, providing deployment restrictions to things like source repos, destination clusters/namespaces, resource definitions etc.
11-
The default project that comes baked in to ArgoCD allows unrestricted deployments.
10+
Argo CD `projects` logically group applications for multiple teams, providing deployment restrictions to things like source repos, destination clusters/namespaces, resource definitions, etc.
11+
The default project that comes baked into ArgoCD allows unrestricted deployments.
1212
New projects should be created for team-specific access levels, managing source repos, destinations, and Kubernetes resource kinds.
13-
Projects can be created with either Argo CD cli or declaratively.
13+
Projects can be created with either Argo CD CLI or declaratively.
1414

1515
An `AppProject` is a custom resource definition (CRD) that defines a project in Argo CD. An example of an `AppProject` is shown below:
1616

@@ -36,12 +36,12 @@ We are going to try out restrictions with the `appproject` kind. We will apply a
3636

3737
### Overview
3838

39-
- create a project manifest
40-
- apply the project manifest
41-
- apply the application manifest that violates the restrictions
42-
- choose selective sync to partially sync the application
39+
- Create a project manifest
40+
- Apply the project manifest
41+
- Apply the application manifest that violates the restrictions
42+
- Choose selective sync to partially sync the application
4343

44-
### Step by step instructions
44+
### Step-by-step instructions
4545

4646
#### Create a project manifest
4747

@@ -69,7 +69,7 @@ spec:
6969

7070
It is a simple project manifest that restricts the deployment to a specific namespace and restricts the deployment of `Role` resources.
7171

72-
- change the `name`, `spec.description` and `spec.destinations.namespace` fields to your student number
72+
- Change the `name`, `spec.description`, and `spec.destinations.namespace` fields to your student number
7373

7474
#### Apply the project manifest
7575

@@ -96,7 +96,7 @@ Go to the ArgoCD UI and see the project from there as well.
9696

9797
- Click on `Settings` -> `Projects` and you should see the project there
9898
- Click on the project and see the details. Here you can see the different options that can be set for the project.
99-
- Verify that the description reflects your student number as well, e.g `a project for student-0 to play with`
99+
- Verify that the description reflects your student number as well, e.g, `a project for student-0 to play with`
100100

101101
#### Apply the application manifest that violates the restrictions
102102

@@ -140,10 +140,10 @@ The project restricts the deployment of `Role` resources, so the application wil
140140
### Optional: Create an application outside your namespace
141141

142142
If time permits, try to create an application that is deployed to a namespace that is not allowed by the project.
143-
> **NOTE:** Don't do this by simply manipulating the destination of the application you just applied as that will
144-
> potentially interfere with the other students exercises.
143+
> **NOTE:** Don't do this by simply manipulating the destination of the application you just applied, as that will
144+
> potentially interfere with the other students' exercises.
145145

146-
What are the differences in the error messages, compared to the previous application?
146+
What are the differences in the error messages compared to the previous application?
147147

148148
### Clean up
149149

sealed-secrets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Sealed Secrets
22

33
* Make a new application manifest for the k8s raw manifest
4-
* take the k8s manifest quotes flask
5-
* look at the postgres secret
6-
* seal the secret with kubeseal
4+
* Take the k8s manifest quotes flask
5+
* Look at the postgres secret
6+
* Seal the secret with kubeseal
77
* Apply the new sealed secret (add to your repo and push it to see that Argo fetches it)
88
* See that everything still works

0 commit comments

Comments
 (0)