Skip to content

Commit

Permalink
docs(workshop): final fixes (#574)
Browse files Browse the repository at this point in the history
* git cleanups

* typos/fixes

* fix namespace
charliedmcb authored Nov 14, 2024
1 parent 4bb4330 commit 3990ae7
Showing 2 changed files with 16 additions and 14 deletions.
16 changes: 9 additions & 7 deletions docs/workshops/1_aks_cluster_creation_and_install_karpenter.md
Original file line number Diff line number Diff line change
@@ -6,11 +6,11 @@ Table of contents:
- [Install Karpenter](#install-karpenter)
- [Create our workshop namespace](#create-our-workshop-namespace)

## Envrionment Setup
## Environment Setup

### Pre-requisite

You must have an Azure account, and personal Azure subscription.
You must have an Azure account, and personal Azure subscription.

> 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.
@@ -19,9 +19,9 @@ You must have an Azure account, and personal Azure subscription.
Open [https://shell.azure.com/](https://shell.azure.com/) in a new tab.

> Note: <br>
> \- 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)
> \- 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)
### Create a Directory for the Workshop
### Create a Directory for the Workshop

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

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

> Note: <br>
> \- 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.
> \- 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.
Create federated credential linked to the karpenter service account for auth usage:

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

You should see the file within the output:

```
bin configure-values.sh karpenter-values-template.yaml karpenter-values.yaml
```
@@ -209,10 +211,10 @@ kubectl create namespace workshop

### K9s

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:
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:

```bash
k9s -n all
```

You can press `?` to learn more about the options and press `:q` to exit from `k9s`.
You can press `?` to learn more about the options and press `:q` to exit from `k9s`.
14 changes: 7 additions & 7 deletions docs/workshops/kubecon_azure_track.md
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ When you see `eks-node-viewer` use `aks-node-viewer` instead.

> 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:
> ```bash
> kubectl -n karpenter logs -f deployment/karpenter --all-containers=true --since=20m
> kubectl -n kube-system logs -f deployment/karpenter --all-containers=true --since=20m
> ```
## Main Topics
@@ -44,7 +44,7 @@ When you see `eks-node-viewer` use `aks-node-viewer` instead.
- 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.
- Adjustments:
- 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)
- 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)
### Step: [Scaling Application](https://catalog.workshops.aws/karpenter/en-US/basic-nodepool/scaling)
@@ -102,7 +102,7 @@ When you see `eks-node-viewer` use `aks-node-viewer` instead.
```bash
kubectl delete aksnodeclass default
```
- 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)
- 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)
### Step: [Multi Node Consolidation](https://catalog.workshops.aws/karpenter/en-US/cost-optimization/consolidation/multi-node)
@@ -144,9 +144,9 @@ Everything beyond this point is optional. Although, if skipping these steps, you
kubectl delete aksnodeclass default
```
- 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)
- > 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.
- > 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.
- > Note: you may see a log for selecting the instance type and resolving the image after nodeclaim creation.
- > Note: `triggering termination for expired node after TTL`, and `deprovisioning via expiration` are not actually expected to show up within the logs.
- > Note: `triggering termination for expired node after TTL`, and `deprovisioning via expiration` are not actually expected to show up within the logs.
## Cleanup
@@ -157,7 +157,7 @@ Once you've completed the workshop, ensure you cleanup all the resources to prev
> env | grep AZURE_SUBSCRIPTION_ID
> ```
> 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):
>
>
> ```bash
> export AZURE_SUBSCRIPTION_ID=<personal-azure-sub>
> 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
```bash
cd ~/
rm -rf ~/environment
```
```

0 comments on commit 3990ae7

Please sign in to comment.