Skip to content

Commit 3990ae7

Browse files
authored
docs(workshop): final fixes (#574)
* git cleanups * typos/fixes * fix namespace
1 parent 4bb4330 commit 3990ae7

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

docs/workshops/1_aks_cluster_creation_and_install_karpenter.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Table of contents:
66
- [Install Karpenter](#install-karpenter)
77
- [Create our workshop namespace](#create-our-workshop-namespace)
88

9-
## Envrionment Setup
9+
## Environment Setup
1010

1111
### Pre-requisite
1212

13-
You must have an Azure account, and personal Azure subscription.
13+
You must have an Azure account, and personal Azure subscription.
1414

1515
> Note: this will use your chosen subscription for any pricing/costs associated with the workshop. At the end of the workshop, see step [Cleanup](https://github.com/Azure/karpenter-provider-azure/blob/main/docs/workshops/kubecon_azure_track.md#cleanup) to ensure all the resources are properly cleaned up to eliminate any additional costs.
1616
@@ -19,9 +19,9 @@ You must have an Azure account, and personal Azure subscription.
1919
Open [https://shell.azure.com/](https://shell.azure.com/) in a new tab.
2020

2121
> Note: <br>
22-
> \- If you do get disconnected from the Cloud Shell, and find your setup is not working, you can use the following document's quick and easy steps to reestablish it: [reestablish_env.md](https://github.com/Azure/karpenter-provider-azure/tree/main/docs/workshops/reestablish_env.md). (this will only work if you have already completed all the steps of installtion in this current doc)
22+
> \- If you do get disconnected from the Cloud Shell, and find your setup is not working, you can use the following document's quick and easy steps to reestablish it: [reestablish_env.md](https://github.com/Azure/karpenter-provider-azure/tree/main/docs/workshops/reestablish_env.md). (this will only work if you have already completed all the steps of installation in this current doc)
2323
24-
### Create a Directory for the Workshop
24+
### Create a Directory for the Workshop
2525

2626
Create the workshop's directory hierarchy, and add it's tooling bin to the path.
2727

@@ -101,7 +101,7 @@ az aks get-credentials --name "${CLUSTER_NAME}" --resource-group "${RG}" --overw
101101
```
102102

103103
> Note: <br>
104-
> \- If you see a warning for "CryptographyDeprecationWarning", "WARNING: SSH key files", and/or "WARNING: docker_bridge_cidr" these are not a concern, and can be disregarded.
104+
> \- If you see a warning for "CryptographyDeprecationWarning", "WARNING: SSH key files", and/or "WARNING: docker_bridge_cidr" these are not a concern, and can be disregarded.
105105
106106
Create federated credential linked to the karpenter service account for auth usage:
107107

@@ -149,6 +149,8 @@ Check the `karpenter-values.yaml` file was created:
149149
ls
150150
```
151151

152+
You should see the file within the output:
153+
152154
```
153155
bin configure-values.sh karpenter-values-template.yaml karpenter-values.yaml
154156
```
@@ -209,10 +211,10 @@ kubectl create namespace workshop
209211

210212
### K9s
211213

212-
You can also try using k9s to inspect the cluster. We'll be using it throughout certain chapers of the workshop to check on the status of the pods deployed to the AKS cluster. To do so, use the command below:
214+
You can also try using k9s to inspect the cluster. We'll be using it throughout certain chapters of the workshop to check on the status of the pods deployed to the AKS cluster. To do so, use the command below:
213215

214216
```bash
215217
k9s -n all
216218
```
217219

218-
You can press `?` to learn more about the options and press `:q` to exit from `k9s`.
220+
You can press `?` to learn more about the options and press `:q` to exit from `k9s`.

docs/workshops/kubecon_azure_track.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When you see `eks-node-viewer` use `aks-node-viewer` instead.
2929

3030
> Note: if you ever end up needing to use the extended log command to look back over a longer period of time, make sure its using the `kube-system` namespace like follows:
3131
> ```bash
32-
> kubectl -n karpenter logs -f deployment/karpenter --all-containers=true --since=20m
32+
> kubectl -n kube-system logs -f deployment/karpenter --all-containers=true --since=20m
3333
> ```
3434
3535
## Main Topics
@@ -44,7 +44,7 @@ When you see `eks-node-viewer` use `aks-node-viewer` instead.
4444
- AKSNodeClass is Azure’s equivalence to EC2NodeClass for Azure specific settings. Each Karpenter NodePool must contain a reference to an AKSNodeClass via the spec.template.spec.nodeClassRef.
4545
4646
- Adjustments:
47-
- The same concepts within the workshop generally translate to AKS. However, for the actual deployment step, we need a `AKSNodeClass`, and a few additional Azure specific adjustments. So, instead of the given deployment command follow [2_basic_noodpool.md](https://github.com/Azure/karpenter-provider-azure/tree/main/docs/workshops/2_basic_noodpool.md)
47+
- The same concepts within the workshop generally translate to AKS. However, for the actual deployment step, we need a `AKSNodeClass`, and a few additional Azure specific adjustments. So, instead of the given deployment command follow [2_basic_noodpool.md](https://github.com/Azure/karpenter-provider-azure/blob/main/docs/workshops/2_basic_nodepool.md)
4848
4949
### Step: [Scaling Application](https://catalog.workshops.aws/karpenter/en-US/basic-nodepool/scaling)
5050
@@ -102,7 +102,7 @@ When you see `eks-node-viewer` use `aks-node-viewer` instead.
102102
```bash
103103
kubectl delete aksnodeclass default
104104
```
105-
- The same concepts within the workshop generally translate to AKS. However, for the deployment step of the NodePool, use a new deployment command with consolidation enabled. Found in [9_single_node_consolidation.md](https://github.com/Azure/karpenter-provider-azure/tree/main/docs/workshops/9_single_node_consolidation.md)
105+
- The same concepts within the workshop generally translate to AKS. However, for the deployment step of the NodePool, use a new deployment command with consolidation enabled. Found in [9_single_node_consolidation.md](https://github.com/Azure/karpenter-provider-azure/tree/main/docs/workshops/9_single_node_consolidation.md)
106106
107107
### Step: [Multi Node Consolidation](https://catalog.workshops.aws/karpenter/en-US/cost-optimization/consolidation/multi-node)
108108
@@ -144,9 +144,9 @@ Everything beyond this point is optional. Although, if skipping these steps, you
144144
kubectl delete aksnodeclass default
145145
```
146146
- The same concepts within the workshop generally translate to AKS. However, for the deployment step of the NodePool, use the deployment command found in [13_disruption_controls.md](https://github.com/Azure/karpenter-provider-azure/tree/main/docs/workshops/13_disruption_controls.md)
147-
- > Note: don't be surprised if after the `expireAfter` of `2m` has occured that there are new instances being created, and removed. This is expected.
147+
- > Note: don't be surprised if after the `expireAfter` of `2m` has occurred that there are new instances being created, and removed. This is expected.
148148
- > Note: you may see a log for selecting the instance type and resolving the image after nodeclaim creation.
149-
- > Note: `triggering termination for expired node after TTL`, and `deprovisioning via expiration` are not actually expected to show up within the logs.
149+
- > Note: `triggering termination for expired node after TTL`, and `deprovisioning via expiration` are not actually expected to show up within the logs.
150150
151151
## Cleanup
152152
@@ -157,7 +157,7 @@ Once you've completed the workshop, ensure you cleanup all the resources to prev
157157
> env | grep AZURE_SUBSCRIPTION_ID
158158
> ```
159159
> If you see no output from the above command, than re-select your subscription to use (replace `<personal-azure-sub>` with your azure subscription guid):
160-
>
160+
>
161161
> ```bash
162162
> export AZURE_SUBSCRIPTION_ID=<personal-azure-sub>
163163
> az account set --subscription ${AZURE_SUBSCRIPTION_ID}
@@ -178,4 +178,4 @@ The Cloud Shell should automatically clean itself up. However, if you want to pr
178178
```bash
179179
cd ~/
180180
rm -rf ~/environment
181-
```
181+
```

0 commit comments

Comments
 (0)