Add flex node added into / remove from Private AKS cluster #55
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| # Private AKS Cluster - Edge Node Join/Leave | ||
|
Collaborator
There was a problem hiding this comment. consolidate with create_private_cluster.md into one usage doc?
Collaborator
Author
There was a problem hiding this comment. yes, will do it. |
||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### 1. Login to Azure CLI | ||
|
|
||
| ```bash | ||
| az login | ||
| ``` | ||
|
|
||
| > **Note:** When running the agent with `sudo`, use `sudo -E` to preserve your Azure CLI token. | ||
|
|
||
| ### 2. Create a Private AKS Cluster | ||
|
|
||
| Create a Private AKS cluster with AAD and Azure RBAC enabled, and assign the required roles to your user. | ||
|
|
||
| See: [create_private_cluster.md](create_private_cluster.md) | ||
|
|
||
| ### 3. Prepare Configuration File | ||
|
|
||
| Create a `config.json` with `"private": true` in the `targetCluster` section: | ||
|
|
||
| ```json | ||
| { | ||
| "azure": { | ||
| "subscriptionId": "<SUBSCRIPTION_ID>", | ||
| "tenantId": "<TENANT_ID>", | ||
| "targetCluster": { | ||
| "resourceId": "/subscriptions/<SUB_ID>/resourceGroups/<RG>/providers/Microsoft.ContainerService/managedClusters/<CLUSTER_NAME>", | ||
| "location": "eastus2", | ||
| "private": true | ||
| }, | ||
| "arc": { | ||
| "enabled": true, | ||
| "resourceGroup": "<RG>", | ||
| "location": "eastus2" | ||
| } | ||
| }, | ||
| "kubernetes": { | ||
| "version": "1.33.0" | ||
| }, | ||
| "containerd": { | ||
| "version": "1.7.11", | ||
| "pauseImage": "mcr.microsoft.com/oss/kubernetes/pause:3.6" | ||
| }, | ||
| "agent": { | ||
| "logLevel": "info", | ||
| "logDir": "/var/log/aks-flex-node" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Join Private AKS Cluster | ||
|
|
||
| ### 1. Build the project | ||
|
|
||
| ```bash | ||
| go build -o aks-flex-node . | ||
| ``` | ||
|
|
||
| ### 2. Join the cluster | ||
|
|
||
| When the config has `"private": true`, the `agent` command automatically sets up the Gateway/VPN before bootstrapping: | ||
|
|
||
| ```bash | ||
| sudo -E ./aks-flex-node agent --config config.json | ||
| ``` | ||
|
|
||
| This will: | ||
| 1. Detect private cluster from config | ||
| 2. Set up Gateway VM and VPN tunnel (WireGuard) | ||
| 3. Run normal bootstrap (Arc, containerd, kubelet, etc.) | ||
| 4. Enter daemon mode for status monitoring | ||
|
|
||
| ### 3. Verify | ||
|
|
||
| ```bash | ||
| kubectl get nodes | ||
| ``` | ||
|
|
||
| ## Leave Private AKS Cluster | ||
|
|
||
| When the config has `"private": true`, the `unbootstrap` command automatically handles VPN/Gateway cleanup: | ||
|
|
||
| ```bash | ||
| sudo -E ./aks-flex-node unbootstrap --config config.json [--cleanup-mode <local|full>] | ||
| ``` | ||
|
|
||
| ### Mode Comparison | ||
|
|
||
| | Mode | Command | Description | | ||
| |------|---------|-------------| | ||
| | `local` (default) | `sudo -E ./aks-flex-node unbootstrap --config config.json` | Remove node and local VPN config, **keep Gateway** for other nodes | | ||
| | `full` | `sudo -E ./aks-flex-node unbootstrap --config config.json --cleanup-mode full` | Remove all components **including Gateway VM and Azure resources** | | ||
|
|
||
| ### When to use each mode | ||
|
|
||
| - **`--cleanup-mode=local`** (default): Other nodes are still using the Gateway, or you plan to rejoin later | ||
| - **`--cleanup-mode=full`**: Last node leaving, clean up all Azure resources (Gateway VM, subnet, NSG, public IP) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rm?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes