Skip to content

Commit

Permalink
address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nawazkh committed Nov 22, 2024
1 parent c5bfdd2 commit ceaefa8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ create-cluster: ## Create a workload development Kubernetes cluster on Azure in
EXP_MACHINE_POOL=true \
EXP_EDGEZONE=true \
EXP_ASO_API=true \
EXP_APISERVER_ILB=false \
EXP_APISERVER_ILB=true \
$(MAKE) create-management-cluster \
create-workload-cluster

Expand Down
19 changes: 10 additions & 9 deletions docs/book/src/developers/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
- [Tilt for dev in CAPZ](#tilt-for-dev-in-capz)
- [Tilt for dev in both CAPZ and CAPI](#tilt-for-dev-in-both-capz-and-capi)
- [Deploying a workload cluster](#deploying-a-workload-cluster)
- [Tilt for development (Microsoft Tenant)](#tilt-for-development-microsoft-tenant)
- [Flavors for development(Microsoft Tenant)](#flavors-for-development-microsoft-tenant)
- [Tilt for dev using internal ILB for internode communication](#tilt-for-dev-using-internal-ilb-for-internode-communication)
- [Flavors for development using internal ILB for internode communication](#flavors-for-development-using-internal-ilb-for-internode-communication)
- [Viewing Telemetry](#viewing-telemetry)
- [Debugging](#debugging)
- [Manual Testing](#manual-testing)
Expand Down Expand Up @@ -154,8 +154,8 @@ development will span both CAPZ and CAPI, then follow the [CAPI and CAPZ instruc
#### Tilt for dev in CAPZ

<aside class="note warning">
<h2> Warning </h2>
If you are a MS Tenant and want to develop in CAPZ, navigate to [Tilt for development (Microsoft Tenant)](#tilt-for-development-microsoft-tenant).
<h1> Warning </h1>
If you are looking to leverage the internal LB for internode communication in your workload cluster, please follow the instructions in the [Tilt for dev using internal ILB for internode communication](#tilt-for-dev-using-internal-ilb-for-internode-communication) section.
</aside>

If you want to develop in CAPZ and get a local development cluster working quickly, this is the path for you.
Expand Down Expand Up @@ -254,11 +254,11 @@ make delete-workload-cluster

> Check out the [self-managed](../self-managed/troubleshooting.md) and [managed](../managed/troubleshooting.md) troubleshooting guides for common errors you might run into.
#### Tilt for development (Microsoft Tenant)
#### Tilt for dev using internal ILB for internode communication

This flow is for developers who want to leverage the internal LB for internode communication in their workload cluster.
You can achieve this by setting the `EXP_APISERVER_ILB` environment variable to `true` in your shell (run `export EXP_APISERVER_ILB=true`) and then create the CAPZ management cluster.

The major difference between developing in CAPZ for MS Tenant and developing in CAPZ for non-MS Tenant is the enabling of the `APIServerILB` feature flag.
Microsoft tenants are required to use the `APIServerILB` feature flag to facilitate intern-node communication in the workload cluster.
You can set this by exporting `EXP_APISERVER_ILB=true` in your shell, i.e. run `export EXP_APISERVER_ILB=true`.
We also encourage you to use AKS cluster as your management cluster.

Outline of the steps:
Expand All @@ -269,6 +269,7 @@ Outline of the steps:
- Run `make acr-login` to login to your ACR.
- Run `docker-push-all` to push all the images to your ACR.
- Run `make aks-create` to create an AKS cluster. _Notice the changes that get applied to the `tilt-settings.yaml` file._
- Run `export EXP_APISERVER_ILB=true` in your shell.
- Run `make tilt-up` to start Tilt.

```
Expand All @@ -277,7 +278,7 @@ TODO:
2. VNet peering should be exported out as a shell script for users to run.
```

##### Flavors for development (Microsoft Tenant)
##### Flavors for development using internal ILB for internode communication

There are two flavors available for development in CAPZ for MSFT Tenant:
- [apiserver-ilb](../../../../templates/cluster-template-apiserver-ilb.yaml): VM based default flavor that brings up native K8s clusters with Linux nodes.
Expand Down

0 comments on commit ceaefa8

Please sign in to comment.