docs(providers): add Azure and Local (kind) provider pages - #715
Open
viniciusdc wants to merge 7 commits into
Open
docs(providers): add Azure and Local (kind) provider pages#715viniciusdc wants to merge 7 commits into
viniciusdc wants to merge 7 commits into
Conversation
Promote Azure and Local from planned stubs to full how-to pages, modeled on the AWS and Hetzner pages and sourced from nebari-infrastructure-core: - Azure: managed AKS deploy/verify/update/upgrade/destroy, DefaultAzureCredential auth with AZURE_SUBSCRIPTION_ID, managed-csi storage, cost notes, and the azure-config.yaml starter. - Local: kind (Kubernetes in Docker) for development and testing. Container runtime prerequisite, self-signed certs, MetalLB gateway access, auto GitOps repo, and the local-config.yaml starter. Corrects the title from K3s to kind. - Update the provider support matrix: Azure and Local now Supported; GCP stays planned.
✅ Deploy Preview for nebari-docs2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…ch classic voice Verified every factual claim against nebari-infrastructure-core code and fixed what had drifted: Azure: - Node pools: an unset mode defaults to User, and nic validates at most one System pool (not 'exactly one required'); reworded and warned accordingly. - Upgrade: nic does no version sequencing; the one-minor-at-a-time rule is AKS platform behavior, now attributed as such. - Cost/destroy: note the shared nic-tfstate-rg state backend that nic destroy leaves in place, and the 128 GB default OS disk. - Note the fixed Azure CNI Overlay networking and user-assigned identity. Local (kind): - Soften the host CPU/RAM guidance to a recommendation (no documented minimum). - Add cautions: unknown cluster.local keys are silently accepted, and kind settings only apply on cluster creation. - Do not state a default Kubernetes version (none is hardcoded). Both pages rewritten in the warmer, more explanatory voice of the legacy Nebari Classic provider docs (contextual intros, a What is kind explainer, and more note/tip/warning guidance).
Contributor
Author
|
Both pages were fact-checked against the
Prose was also warmed to match the voice of the legacy Nebari Classic provider docs. |
The account prerequisite linked to the free-tier signup and then said 'does not fit within the free tier', which could leave a new user thinking a cloud deploy is free. Add an upfront warning on the AWS and Azure pages stating a cloud deployment is billed (not a free-tier workload) and pointing free-trial users to Local (kind). Reword the account and cost lines to match: Azure notes the control plane is free on the Free SKU but VMs/disks/LB bill (and the 30-day credit can fund a short evaluation); AWS notes EKS/NAT/LB bill regardless of instance size.
Reword the AWS/Azure not-free warnings in the legacy Nebari Classic phrasing
('will not fall within free-tier usage; review the pricing docs or check with
your cloud administrator').
Docs-review pass (references verified against nebari-dev source and live URLs):
- AWS: replace the stale EKS-regions link (it now redirects to the generic EKS
index) with the AWS Regional Services List.
- Azure: use the canonical DefaultAzureCredential doc URL; trim the cost line
that repeated the warning; shorten the duplicated System-pool comment.
- Local: uncomment the /etc/hosts example line and use backticks for
'thisisunsafe' instead of an HTML tag.
- Sidebar: list GCP (planned) after the supported providers, matching the
support matrix order.
Swap em dashes for colons, semicolons, commas, or parentheses across the Azure, Local, and AWS provider pages (including a few pre-existing ones on the AWS page). Numeric-range en dashes and the upgrade-path arrows are left as-is.
Document how to serve a locally-trusted TLS certificate on a local (kind) deployment so the browser stops warning about the self-signed default. Uses mkcert to install a trusted local CA and issue a cert covering the apex and subdomains (keycloak/argocd are subdomains of the configured domain), then wires it in via certificate.type: existing with files.cert_file/key_file, which nic reads on the host and turns into the gateway TLS secret. Links the upstream custom TLS certificate guide for the remaining options.
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
1 participant
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.
What this does
Promotes the Azure and Local providers from planned stubs to full how-to pages, matching the structure of the existing AWS and Hetzner pages. Both providers are implemented and usable on
mainin nebari-infrastructure-core, so their pages now document the real deploy/verify/update/destroy lifecycle instead of a "Planned" banner. GCP stays a planned stub.Azure (
azure.mdx)DefaultAzureCredential); the only required variable isAZURE_SUBSCRIPTION_ID(exported to OpenTofu asARM_SUBSCRIPTION_ID), soaz loginis enough.managed-csi); shared RWX/Longhorn is not yet wired for Azure, and the page says so.mode: Systempool, cost notes, and theazure-config.yamlstarter.Local (
local.mdx)nicembeds kind, so no separate kind install.nebari.localmapped to the MetalLB gateway IP, auto GitOps repo at~/.nic/gitops/<project>, and thelocal-config.yamlstarter. Framed as development/testing, not production.Support matrix (
index.mdx)Source
All provider specifics (example configs, credentials, config-reference anchors, kubeconfig retrieval, mechanics) were taken from
nebari-infrastructure-coreonmain. Notably, neither Azure nor Local uses the~/.cache/nickubeconfig path (that is Hetzner-specific); both usenic kubeconfig.Testing
npm run buildsucceeds; no new broken links or anchors (only pre-existing/classic/and/community/ones).Notes for review
docs/local-kind-development.mdguide rather than restating them.