Repository navigation
docs(website): self-hosting on Kubernetes and AKS - #1475
Draft
Cedric Vidal (cedricvidal) wants to merge 2 commits into
Draft
Cedric Vidal (cedricvidal) wants to merge 2 commits into
Cedric Vidal (cedricvidal) wants to merge 2 commits into
Conversation
Overview, AKS provisioning with azd and Bicep, Helm and Flux deploy paths, configuration reference, and operations. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Adds a Self-hosting section to the website covering Kubernetes deployment and AKS infrastructure provisioning, written ahead of open-sourcing the deployment descriptors and IaC into this repo.
Important
Do not merge until the Helm chart (
deploy/helm/scope) and AKS IaC (infra/aks) land in this repo. Before merging, reconcile every page against the landed code.New pages (
website/src/content/docs/self-hosting/):overviewprovision-aksazd upwith Bicep: modules, node pools, identities, env vars, add-ons, outputs, teardowndeploy-helmhelm upgrade --install, verify, upgrade, rollback, uninstalldeploy-fluxGitRepository+HelmReleasewithvaluesFrom: infra-outputs, promotion, suspend/resume, private forks, image automationconfigurationoperationsAlso: Self-hosting sidebar group, cross-links from Access, Local development, Development guide, and Troubleshooting, and glossary entries (Helm chart, Flux, ESO, ASO, KEDA).
Assumptions to verify when the code lands
The pages are modeled on the current internal Kustomize manifests and azd/Bicep infra, adapted to a Helm chart. Everything below is assumed:
deploy/helm/scope, IaC atinfra/aks. Install is from a checkout (helm install scope ./deploy/helm/scope).scope, namespacescoped, images at<registry>/scoped/<component>:<tag>.image.{registry,tag,repositoryPrefix},azure.tenantId,azure.keyVault.uri,azure.workloadIdentity.{externalSecretsClientId,tokenManagerClientId},azure.storage.{accountName,accountArmId},azure.cosmosDb.accountArmId,auth.entra.{enabled,authority,apiClientId},workers.<name>.{enabled,minReplicas,maxReplicas,queueLength},<component>.replicas,kubedock.enabled,otelCollector.enabled,externalSecrets.enabled,azureServiceOperator.enabled,portal.service.{type,annotations},portal.ingress.{enabled,className,host,tls.clusterIssuer},mongo.database.DEPLOY_FLUX=trueinstalls the Flux Operator and writes theinfra-outputsConfigMap toflux-system.AZURE_KEYVAULT_URI,KV_SECRETS_OFFICER_IDENTITY_CLIENT_ID,DEPLOY_WINDOWS_CLUSTER,ALERT_EMAIL_RECIPIENTS).Demos
Docs-only change. Walkthrough of the new Self-hosting pages and cross-links (headless recording, ~110 s).
Before
N/A
After
self-hosting-walkthrough.mp4
Testing
cd website && pnpm testpassed (7/7).SITE=https://microsoft.github.io BASE_PATH=/scope pnpm run buildpassed (224 pages, including all 6self-hosting/*pages).#anchoracross the docs against the built HTML: 41 files, 0 broken.Documentation and compatibility
The change is documentation only. No breaking changes.
Checklist
up()/down()and keep it CosmosDB-compatible. N/ANOTICE/NOTICE-REVIEW.txtwithpnpm noticeas needed. N/A