From 1a1a392d69de292e0c54a4fe9e06904183f0fc8f Mon Sep 17 00:00:00 2001 From: Ellis Tarn Date: Thu, 13 Jan 2022 16:07:50 -0800 Subject: [PATCH] Added preview doc --- .gitignore | 1 + Makefile | 2 +- website/config.toml | 157 ------------------ website/config.yaml | 80 +++++++++ website/content/en/_index.html | 2 +- .../en/{docs => preview}/AWS/_index.md | 0 .../{docs => preview}/AWS/launch-templates.md | 0 .../en/{docs => preview}/AWS/provisioning.md | 0 .../content/en/{docs => preview}/_index.md | 6 +- .../en/{docs => preview}/concepts/_index.md | 0 .../development-guide.md | 1 - website/content/en/{docs => preview}/faq.md | 28 ++-- .../getting-started-with-kops/_index.md | 0 .../getting-started-with-terraform/_index.md | 0 .../getting-started/_index.md | 0 .../getting-started/cloudformation.yaml | 0 .../getting-started/grafana-values.yaml | 0 .../getting-started/prometheus-values.yaml | 0 .../en/{docs => preview}/provisioner.md | 0 .../content/en/{docs => preview}/reinvent.md | 0 .../en/{docs => preview}/tasks/_index.md | 0 .../{docs => preview}/tasks/deprovisioning.md | 0 .../{docs => preview}/tasks/provisioning.md | 0 .../en/{docs => preview}/tasks/scheduling.md | 0 .../en/{v0.4.3-docs => v0.4.3}/_index.md | 0 .../cloud-providers/AWS/_index.md | 0 .../cloud-providers/AWS/aws-spec-fields.md | 0 .../cloud-providers/AWS/launch-templates.md | 0 .../cloud-providers/_index.md | 0 .../concepts/_index.md | 0 .../development-guide.md | 1 - .../en/{v0.4.3-docs => v0.4.3}/faqs.md | 0 .../getting-started/_index.md | 0 .../getting-started/cloudformation.yaml | 0 .../getting-started/grafana-values.yaml | 0 .../getting-started/prometheus-values.yaml | 0 .../provisioner-crd.md | 0 .../en/{v0.5.0-docs => v0.5.0}/AWS/_index.md | 0 .../AWS/launch-templates.md | 0 .../AWS/provisioning.md | 0 .../en/{v0.5.0-docs => v0.5.0}/_index.md | 0 .../concepts/_index.md | 0 .../development-guide.md | 1 - .../getting-started/_index.md | 0 .../getting-started/cloudformation.yaml | 0 .../en/{v0.5.0-docs => v0.5.0}/provisioner.md | 0 .../en/{v0.5.0-docs => v0.5.0}/reinvent.md | 0 .../{v0.5.0-docs => v0.5.0}/tasks/_index.md | 0 .../tasks/deprov-nodes.md | 0 .../tasks/provisioning-task.md | 0 .../tasks/running-pods.md | 0 .../en/{v0.5.2-docs => v0.5.2}/AWS/_index.md | 0 .../AWS/launch-templates.md | 0 .../AWS/provisioning.md | 0 .../en/{v0.5.2-docs => v0.5.2}/_index.md | 0 .../concepts/_index.md | 0 .../en/{docs => v0.5.2}/development-guide.md | 1 - .../getting-started/_index.md | 0 .../getting-started/cloudformation.yaml | 0 .../en/{v0.5.2-docs => v0.5.2}/provisioner.md | 0 .../en/{v0.5.2-docs => v0.5.2}/reinvent.md | 0 .../{v0.5.2-docs => v0.5.2}/tasks/_index.md | 0 .../tasks/deprov-nodes.md | 0 .../tasks/provisioning-task.md | 0 .../tasks/running-pods.md | 0 .../en/{v0.5.3-docs => v0.5.3}/AWS/_index.md | 0 .../AWS/launch-templates.md | 0 .../AWS/provisioning.md | 0 .../en/{v0.5.3-docs => v0.5.3}/_index.md | 2 + .../concepts/_index.md | 0 .../development-guide.md | 1 - .../getting-started-with-kops/_index.md | 0 .../getting-started-with-terraform/_index.md | 0 .../getting-started/_index.md | 3 - .../getting-started/cloudformation.yaml | 0 .../getting-started/grafana-values.yaml | 0 .../getting-started/prometheus-values.yaml | 0 .../en/{v0.5.3-docs => v0.5.3}/provisioner.md | 22 +-- .../en/{v0.5.3-docs => v0.5.3}/reinvent.md | 0 .../{v0.5.3-docs => v0.5.3}/tasks/_index.md | 0 .../tasks/deprov-nodes.md | 0 .../tasks/provisioning-task.md | 0 .../tasks/running-pods.md | 0 website/layouts/partials/hooks/body-end.html | 42 +++-- .../partials/navbar-version-selector.html | 12 +- 85 files changed, 132 insertions(+), 230 deletions(-) delete mode 100644 website/config.toml create mode 100644 website/config.yaml rename website/content/en/{docs => preview}/AWS/_index.md (100%) rename website/content/en/{docs => preview}/AWS/launch-templates.md (100%) rename website/content/en/{docs => preview}/AWS/provisioning.md (100%) rename website/content/en/{docs => preview}/_index.md (95%) rename website/content/en/{docs => preview}/concepts/_index.md (100%) rename website/content/en/{v0.5.2-docs => preview}/development-guide.md (92%) rename website/content/en/{docs => preview}/faq.md (75%) rename website/content/en/{docs => preview}/getting-started-with-kops/_index.md (100%) rename website/content/en/{docs => preview}/getting-started-with-terraform/_index.md (100%) rename website/content/en/{v0.5.3-docs => preview}/getting-started/_index.md (100%) rename website/content/en/{docs => preview}/getting-started/cloudformation.yaml (100%) rename website/content/en/{docs => preview}/getting-started/grafana-values.yaml (100%) rename website/content/en/{docs => preview}/getting-started/prometheus-values.yaml (100%) rename website/content/en/{docs => preview}/provisioner.md (100%) rename website/content/en/{docs => preview}/reinvent.md (100%) rename website/content/en/{docs => preview}/tasks/_index.md (100%) rename website/content/en/{docs => preview}/tasks/deprovisioning.md (100%) rename website/content/en/{docs => preview}/tasks/provisioning.md (100%) rename website/content/en/{docs => preview}/tasks/scheduling.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/_index.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/cloud-providers/AWS/_index.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/cloud-providers/AWS/aws-spec-fields.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/cloud-providers/AWS/launch-templates.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/cloud-providers/_index.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/concepts/_index.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/development-guide.md (92%) rename website/content/en/{v0.4.3-docs => v0.4.3}/faqs.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/getting-started/_index.md (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/getting-started/cloudformation.yaml (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/getting-started/grafana-values.yaml (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/getting-started/prometheus-values.yaml (100%) rename website/content/en/{v0.4.3-docs => v0.4.3}/provisioner-crd.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/AWS/_index.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/AWS/launch-templates.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/AWS/provisioning.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/_index.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/concepts/_index.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.0}/development-guide.md (92%) rename website/content/en/{v0.5.0-docs => v0.5.0}/getting-started/_index.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/getting-started/cloudformation.yaml (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/provisioner.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/reinvent.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/tasks/_index.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/tasks/deprov-nodes.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/tasks/provisioning-task.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.0}/tasks/running-pods.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/AWS/_index.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/AWS/launch-templates.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/AWS/provisioning.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/_index.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/concepts/_index.md (100%) rename website/content/en/{docs => v0.5.2}/development-guide.md (92%) rename website/content/en/{v0.5.2-docs => v0.5.2}/getting-started/_index.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/getting-started/cloudformation.yaml (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/provisioner.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/reinvent.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/tasks/_index.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/tasks/deprov-nodes.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/tasks/provisioning-task.md (100%) rename website/content/en/{v0.5.2-docs => v0.5.2}/tasks/running-pods.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/AWS/_index.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/AWS/launch-templates.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/AWS/provisioning.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/_index.md (98%) rename website/content/en/{v0.5.3-docs => v0.5.3}/concepts/_index.md (100%) rename website/content/en/{v0.5.0-docs => v0.5.3}/development-guide.md (92%) rename website/content/en/{v0.5.3-docs => v0.5.3}/getting-started-with-kops/_index.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/getting-started-with-terraform/_index.md (100%) rename website/content/en/{docs => v0.5.3}/getting-started/_index.md (99%) rename website/content/en/{v0.5.3-docs => v0.5.3}/getting-started/cloudformation.yaml (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/getting-started/grafana-values.yaml (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/getting-started/prometheus-values.yaml (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/provisioner.md (92%) rename website/content/en/{v0.5.3-docs => v0.5.3}/reinvent.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/tasks/_index.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/tasks/deprov-nodes.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/tasks/provisioning-task.md (100%) rename website/content/en/{v0.5.3-docs => v0.5.3}/tasks/running-pods.md (100%) diff --git a/.gitignore b/.gitignore index 65d669ecd672..b4f96af73b4e 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ coverage.html *.csv website/node_modules website/resources +website/public diff --git a/Makefile b/Makefile index e4da4aac12b6..8e7ea7a1295a 100644 --- a/Makefile +++ b/Makefile @@ -88,7 +88,7 @@ helm: ## Generate Helm Chart helm-docs website: ## Generate Docs Website - cd website; npm install; git submodule update --init --recursive; hugo + cp -r website/content/en/preview website/content/en/${RELEASE_VERSION} toolchain: ## Install developer toolchain ./hack/toolchain.sh diff --git a/website/config.toml b/website/config.toml deleted file mode 100644 index ae326f04edcb..000000000000 --- a/website/config.toml +++ /dev/null @@ -1,157 +0,0 @@ -# Hugo allows theme composition (and inheritance). The precedence is from left to right. -theme = ["docsy"] - -# Build settings -baseURL = "/" -disableKinds = ["taxonomy", "taxonomyTerm"] - -# Language settings -enableRobotsTXT = true -contentDir = "content/en" -defaultContentLanguage = "en" -defaultContentLanguageInSubdir = false -# Useful when translating. -enableMissingTranslationPlaceholders = true - -[services.googleAnalytics] -id = "G-NT6C9QZZQ0" - -# Localizations -languageCode = "en-us" -[languages] -[languages.en] -title = "Karpenter" -description = "Just-in-time Nodes for Any Kubernetes Cluster" -languageName = "English" -# Weight used for sorting. -weight = 1 - -# Syntax Highlighting config -pygmentsCodeFences = true -pygmentsUseClasses = false -# Use the new Chroma Go highlighter in Hugo. -pygmentsUseClassic = false -#pygmentsOptions = "linenos=table" -# See https://help.farbox.com/pygments.html -pygmentsStyle = "tango" - -# Configure how URLs look like per section. -[permalinks] -blog = "/:section/:year/:month/:day/:slug/" - -## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday -[blackfriday] -plainIDAnchors = true -hrefTargetBlank = true -angledQuotes = false -latexDashes = true - -# Markup configuration -[markup] -[markup.goldmark] -[markup.goldmark.renderer] -unsafe = true -[markup.highlight] -# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html -style = "tango" -# Uncomment if you want your chosen highlight style used for code blocks without a specified language -# guessSyntax = "true" - -# Image processing configuration. -[imaging] -resampleFilter = "CatmullRom" -quality = 75 -anchor = "smart" - -## Site Params -[params] - -latest_release_version = "0.5.3" - -copyright = "Amazon.com, Inc. or its affiliates." -# Repository configuration (URLs for in-page links to opening issues and suggesting changes) -github_repo = "https://github.com/aws/karpenter" -# Specify a value here if your content directory is not in your repo's root directory -github_subdir = "website" -github_branch= "main" -# Twitter card images (banner with logo) -images = ["banner.png"] - -# Version configuration -# Menu title if your navbar has a versions selector to access old versions of your site. -# This menu appears only if you have at least one [params.versions] set. -version_menu = "Releases" - -# Flag used in the "version-banner" partial to decide whether to display a -# banner on every page indicating that this is an archived version of the docs. -# Set this flag to "true" if you want to display the banner. -archived_version = false -# The version number for the version of the docs represented in this doc set. -# Used in the "version-banner" partial to display a version number for the -# current doc set. -version = "0.2" - -# Enable local search -offlineSearch = true - -# User interface configuration -[params.ui] -# Enable to show the side bar menu in its compact state. -sidebar_menu_compact = true -sidebar_menu_foldable = true - -# Set to true to disable breadcrumb navigation. -breadcrumb_disable = false -# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) -sidebar_search_disable = false -# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar -navbar_logo = true -# Set to true to disable the About link in the site footer -footer_about_disable = true - -[params.links] -# End user relevant links. These will show up on left side of footer and in the community page if you have one. -#[[params.links.user]] -# name = "Twitter" -# url = "https://example.org/twitter" -# icon = "fab fa-twitter" -# desc = "Follow us on Twitter to get the latest news!" -# Developer relevant links. These will show up on right side of footer and in the community page if you have one. -[[params.links.developer]] - name = "GitHub" - url = "https://github.com/aws/karpenter" - icon = "fab fa-github" - desc = "Development takes place here!" -[[params.links.developer]] - name = "Slack" - url = "https://slack.k8s.io/" - icon = "fab fa-slack" - desc = "Chat with us on Slack in the #aws-provider channel" - -# Navigation menu -[[menu.main]] -name = "GitHub" -weight = 99 -url = "https://github.com/aws/karpenter" -pre = "" - -# Add your release versions here -[[params.versions]] - version = "v0.5.4" - url = "/docs/" - -[[params.versions]] - version = "v0.5.3" - url = "/v0.5.3-docs/" - -[[params.versions]] - version = "v0.5.2" - url = "/v0.5.2-docs/" - -[[params.versions]] - version = "v0.5.0" - url = "/v0.5.0-docs/" - -[[params.versions]] - version = "v0.4.3" - url = "/v0.4.3-docs/" diff --git a/website/config.yaml b/website/config.yaml new file mode 100644 index 000000000000..0f6632d58004 --- /dev/null +++ b/website/config.yaml @@ -0,0 +1,80 @@ +theme: + - docsy +baseURL: / +disableKinds: + - taxonomy + - taxonomyTerm +enableRobotsTXT: true +contentDir: content/en +defaultContentLanguage: en +defaultContentLanguageInSubdir: false +enableMissingTranslationPlaceholders: true +services: + googleAnalytics: + id: G-NT6C9QZZQ0 + languageCode: en-us +languages: + en: + title: Karpenter + description: Just-in-time Nodes for Any Kubernetes Cluster + languageName: English + weight: 1 + pygmentsCodeFences: true + pygmentsUseClasses: false + pygmentsUseClassic: false + pygmentsStyle: tango +blackfriday: + plainIDAnchors: true + hrefTargetBlank: true + angledQuotes: false + latexDashes: true +markup: + goldmark: + renderer: + unsafe: true + highlight: + style: tango +imaging: + resampleFilter: CatmullRom + quality: 75 + anchor: smart +params: + copyright: 'Amazon.com, Inc. or its affiliates.' + github_repo: 'https://github.com/aws/karpenter' + github_subdir: website + github_branch: main + images: + - banner.png + version_menu: Releases + archived_version: false + offlineSearch: true + ui: + sidebar_menu_compact: true + sidebar_menu_foldable: true + breadcrumb_disable: false + sidebar_search_disable: false + navbar_logo: true + footer_about_disable: true + links: + developer: + - name: GitHub + url: 'https://github.com/aws/karpenter' + icon: fab fa-github + desc: Development takes place here! + - name: Slack + url: 'https://slack.k8s.io/' + icon: fab fa-slack + desc: 'Chat with us on Slack in the #aws-provider channel' + latest_release_version: v0.5.3 + versions: + - "v0.5.3" + - "v0.5.2" + - "v0.5.0" + - "v0.4.3" + - "preview" +menu: + main: + - name: GitHub + weight: 99 + url: 'https://github.com/aws/karpenter' + pre: diff --git a/website/content/en/_index.html b/website/content/en/_index.html index 936cc9fce920..cb8897c84f95 100644 --- a/website/content/en/_index.html +++ b/website/content/en/_index.html @@ -8,7 +8,7 @@

Karpenter

Just-in-time Nodes for Any Kubernetes Cluster

- }}"> + Get Started
diff --git a/website/content/en/docs/AWS/_index.md b/website/content/en/preview/AWS/_index.md similarity index 100% rename from website/content/en/docs/AWS/_index.md rename to website/content/en/preview/AWS/_index.md diff --git a/website/content/en/docs/AWS/launch-templates.md b/website/content/en/preview/AWS/launch-templates.md similarity index 100% rename from website/content/en/docs/AWS/launch-templates.md rename to website/content/en/preview/AWS/launch-templates.md diff --git a/website/content/en/docs/AWS/provisioning.md b/website/content/en/preview/AWS/provisioning.md similarity index 100% rename from website/content/en/docs/AWS/provisioning.md rename to website/content/en/preview/AWS/provisioning.md diff --git a/website/content/en/docs/_index.md b/website/content/en/preview/_index.md similarity index 95% rename from website/content/en/docs/_index.md rename to website/content/en/preview/_index.md index 98f87b24634d..fd0addc59a24 100755 --- a/website/content/en/docs/_index.md +++ b/website/content/en/preview/_index.md @@ -3,10 +3,8 @@ title: "Documentation" linkTitle: "Docs" weight: 20 -menu: - main: - weight: 20 - pre: +cascade: + type: docs --- Karpenter is an open-source node provisioning project built for Kubernetes. Adding Karpenter to a Kubernetes cluster can dramatically improve the efficiency and cost of running workloads on that cluster. diff --git a/website/content/en/docs/concepts/_index.md b/website/content/en/preview/concepts/_index.md similarity index 100% rename from website/content/en/docs/concepts/_index.md rename to website/content/en/preview/concepts/_index.md diff --git a/website/content/en/v0.5.2-docs/development-guide.md b/website/content/en/preview/development-guide.md similarity index 92% rename from website/content/en/v0.5.2-docs/development-guide.md rename to website/content/en/preview/development-guide.md index 921661900f91..2935246847a0 100644 --- a/website/content/en/v0.5.2-docs/development-guide.md +++ b/website/content/en/preview/development-guide.md @@ -34,7 +34,6 @@ make delete # Uninstall Karpenter * Make sure you have valid credentials to your development repository. * `$KO_DOCKER_REPO` must point to your development repository * Your cluster must have permissions to read from the repository -* If you created your cluster on version 1.19 or above, you may need to tag your subnets as mentioned [here]({{< ref "/docs/getting-started/_index.md#tag-subnets" >}}). This is a temporary problem with our subnet discovery system, and is being tracked [here](https://github.com/aws/karpenter/issues/404#issuecomment-845283904). * It's also a good idea to persist `$CLOUD_PROVIDER` in your environment variables to simplify the `make apply` command. ### Build and Deploy diff --git a/website/content/en/docs/faq.md b/website/content/en/preview/faq.md similarity index 75% rename from website/content/en/docs/faq.md rename to website/content/en/preview/faq.md index 8116d2ee4d32..89438bea125f 100644 --- a/website/content/en/docs/faq.md +++ b/website/content/en/preview/faq.md @@ -6,11 +6,11 @@ weight: 90 ## General ### How does a provisioner decide to manage a particular node? -See [Configuring provisioners]({{< ref "/docs/concepts/#configuring-provisioners" >}}) for information on how Karpenter provisions and manages nodes. +See [Configuring provisioners]({{< ref "./concepts/#configuring-provisioners" >}}) for information on how Karpenter provisions and manages nodes. ### What cloud providers are supported? AWS is the first cloud provider supported by Karpenter, although it is designed to be used with other cloud providers as well. -See [[Cloud provider]({{< ref "/docs/concepts/#cloud-provider" >}}) for details. +See [[Cloud provider]({{< ref "./concepts/#cloud-provider" >}}) for details. ### Can I write my own cloud provider for Karpenter? Yes, but there is no documentation yet for it. @@ -21,10 +21,10 @@ By default, Karpenter uses Amazon Linux 2 images. ### Can I provide my own custom operating system images? Karpenter allows you to create your own AWS AMIs using custom launch templates. -See [Launch Templates and Custom Images]({{< ref "/docs/aws/launch-templates/" >}}) for details. +See [Launch Templates and Custom Images]({{< ref "./aws/launch-templates/" >}}) for details. ### Can Karpenter deal with workloads for mixed architecture cluster (arm vs. amd)? -Yes. Build and prepare custom arm images as described in [Launch Templates and Custom Images]({{< ref "/docs/aws/launch-templates/" >}}). +Yes. Build and prepare custom arm images as described in [Launch Templates and Custom Images]({{< ref "./aws/launch-templates/" >}}). Specify the desired architecture when you deploy workloads. ### What RBAC access is required? @@ -52,17 +52,17 @@ We expect most users will use a mixed approach in the near term and provisioner- ### How does Karpenter interact with Kubernetes features? * Kubernetes Cluster Autoscaler: Karpenter can work alongside cluster autoscaler. -See [Kubernetes cluster autoscaler]({{< ref "/docs/concepts/#kubernetes-cluster-autoscaler" >}}) for details. +See [Kubernetes cluster autoscaler]({{< ref "./concepts/#kubernetes-cluster-autoscaler" >}}) for details. * Kubernetes Scheduler: Karpenter focuses on scheduling pods that the Kubernetes scheduler has marked as unschedulable. -See [Scheduling]({{< ref "/docs/concepts/#scheduling" >}}) for details on how Karpenter interacts with the Kubernetes scheduler. +See [Scheduling]({{< ref "./concepts/#scheduling" >}}) for details on how Karpenter interacts with the Kubernetes scheduler. ## Provisioning ### What features does the Karpenter provisioner support? -See [Provisioner API]({{< ref "/docs/provisioner" >}}) for provisioner examples and descriptions of features. +See [Provisioner API]({{< ref "./provisioner" >}}) for provisioner examples and descriptions of features. ### Can I create multiple (team-based) provisioners on a cluster? Yes, provisioners can identify multiple teams based on labels. -See [Provisioner API]({{< ref "/docs/provisioner" >}}) for details. +See [Provisioner API]({{< ref "./provisioner" >}}) for details. ### If multiple provisioners are defined, which will my pod use? @@ -73,10 +73,10 @@ You must either define a default provisioner or explicitly specify `karpenter.sh ### Can I set total limits of CPU and memory for a provisioner? Yes, the setting is provider-specific. -See examples in [Accelerators, GPU]({{< ref "/docs/aws/provisioning/#accelerators-gpu" >}}) Karpenter documentation. +See examples in [Accelerators, GPU]({{< ref "./aws/provisioning/#accelerators-gpu" >}}) Karpenter documentation. ### Can I mix spot and on-demand EC2 run types? -Yes, see [Example Provisioner Resource]({{< ref "/docs/provisioner/#example-provisioner-resource" >}}) for an example. +Yes, see [Example Provisioner Resource]({{< ref "./provisioner/#example-provisioner-resource" >}}) for an example. ### Can I restrict EC2 instance types? @@ -87,14 +87,14 @@ Yes, see [Example Provisioner Resource]({{< ref "/docs/provisioner/#example-prov ### How can someone deploying pods take advantage of Karpenter? -See [Application developer]({{< ref "/docs/concepts/#application-developer" >}}) for descriptions of how Karpenter matches nodes with pod requests. +See [Application developer]({{< ref "./concepts/#application-developer" >}}) for descriptions of how Karpenter matches nodes with pod requests. ### How do I use Karpenter with the AWS load balancer controller? -* Set the [ALB target type]({{< ref "https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.3/guide/ingress/annotations/#target-type" >}}) to IP mode for the pods. +* Set the [ALB target type]("https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.3/guide/ingress/annotations/#target-type") to IP mode for the pods. Use IP targeting if you want the pods to receive equal weight. Instance balancing could greatly skew the traffic being sent to a node without also managing host spread of the workload. -* Set [readiness gate]({{< ref "https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.3/deploy/pod_readiness_gate/" >}}) on the namespace. +* Set [readiness gate]({"https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.3/deploy/pod_readiness_gate/") on the namespace. The default is round robin at the node level. For Karpenter, not all nodes are equal. For example, each node will have different performance characteristics and a different number of pods running on it. @@ -109,7 +109,7 @@ Not yet. ## Deprovisioning ### How does Karpenter deprovision nodes? -See [Deprovisioning nodes]({{< ref "/docs/tasks/deprov-nodes" >}}) for information on how Karpenter deprovisions nodes. +See [Deprovisioning nodes]({{< ref "./tasks/deprovisioning" >}}) for information on how Karpenter deprovisions nodes. ## Upgrading ### How do I upgrade Karpenter? diff --git a/website/content/en/docs/getting-started-with-kops/_index.md b/website/content/en/preview/getting-started-with-kops/_index.md similarity index 100% rename from website/content/en/docs/getting-started-with-kops/_index.md rename to website/content/en/preview/getting-started-with-kops/_index.md diff --git a/website/content/en/docs/getting-started-with-terraform/_index.md b/website/content/en/preview/getting-started-with-terraform/_index.md similarity index 100% rename from website/content/en/docs/getting-started-with-terraform/_index.md rename to website/content/en/preview/getting-started-with-terraform/_index.md diff --git a/website/content/en/v0.5.3-docs/getting-started/_index.md b/website/content/en/preview/getting-started/_index.md similarity index 100% rename from website/content/en/v0.5.3-docs/getting-started/_index.md rename to website/content/en/preview/getting-started/_index.md diff --git a/website/content/en/docs/getting-started/cloudformation.yaml b/website/content/en/preview/getting-started/cloudformation.yaml similarity index 100% rename from website/content/en/docs/getting-started/cloudformation.yaml rename to website/content/en/preview/getting-started/cloudformation.yaml diff --git a/website/content/en/docs/getting-started/grafana-values.yaml b/website/content/en/preview/getting-started/grafana-values.yaml similarity index 100% rename from website/content/en/docs/getting-started/grafana-values.yaml rename to website/content/en/preview/getting-started/grafana-values.yaml diff --git a/website/content/en/docs/getting-started/prometheus-values.yaml b/website/content/en/preview/getting-started/prometheus-values.yaml similarity index 100% rename from website/content/en/docs/getting-started/prometheus-values.yaml rename to website/content/en/preview/getting-started/prometheus-values.yaml diff --git a/website/content/en/docs/provisioner.md b/website/content/en/preview/provisioner.md similarity index 100% rename from website/content/en/docs/provisioner.md rename to website/content/en/preview/provisioner.md diff --git a/website/content/en/docs/reinvent.md b/website/content/en/preview/reinvent.md similarity index 100% rename from website/content/en/docs/reinvent.md rename to website/content/en/preview/reinvent.md diff --git a/website/content/en/docs/tasks/_index.md b/website/content/en/preview/tasks/_index.md similarity index 100% rename from website/content/en/docs/tasks/_index.md rename to website/content/en/preview/tasks/_index.md diff --git a/website/content/en/docs/tasks/deprovisioning.md b/website/content/en/preview/tasks/deprovisioning.md similarity index 100% rename from website/content/en/docs/tasks/deprovisioning.md rename to website/content/en/preview/tasks/deprovisioning.md diff --git a/website/content/en/docs/tasks/provisioning.md b/website/content/en/preview/tasks/provisioning.md similarity index 100% rename from website/content/en/docs/tasks/provisioning.md rename to website/content/en/preview/tasks/provisioning.md diff --git a/website/content/en/docs/tasks/scheduling.md b/website/content/en/preview/tasks/scheduling.md similarity index 100% rename from website/content/en/docs/tasks/scheduling.md rename to website/content/en/preview/tasks/scheduling.md diff --git a/website/content/en/v0.4.3-docs/_index.md b/website/content/en/v0.4.3/_index.md similarity index 100% rename from website/content/en/v0.4.3-docs/_index.md rename to website/content/en/v0.4.3/_index.md diff --git a/website/content/en/v0.4.3-docs/cloud-providers/AWS/_index.md b/website/content/en/v0.4.3/cloud-providers/AWS/_index.md similarity index 100% rename from website/content/en/v0.4.3-docs/cloud-providers/AWS/_index.md rename to website/content/en/v0.4.3/cloud-providers/AWS/_index.md diff --git a/website/content/en/v0.4.3-docs/cloud-providers/AWS/aws-spec-fields.md b/website/content/en/v0.4.3/cloud-providers/AWS/aws-spec-fields.md similarity index 100% rename from website/content/en/v0.4.3-docs/cloud-providers/AWS/aws-spec-fields.md rename to website/content/en/v0.4.3/cloud-providers/AWS/aws-spec-fields.md diff --git a/website/content/en/v0.4.3-docs/cloud-providers/AWS/launch-templates.md b/website/content/en/v0.4.3/cloud-providers/AWS/launch-templates.md similarity index 100% rename from website/content/en/v0.4.3-docs/cloud-providers/AWS/launch-templates.md rename to website/content/en/v0.4.3/cloud-providers/AWS/launch-templates.md diff --git a/website/content/en/v0.4.3-docs/cloud-providers/_index.md b/website/content/en/v0.4.3/cloud-providers/_index.md similarity index 100% rename from website/content/en/v0.4.3-docs/cloud-providers/_index.md rename to website/content/en/v0.4.3/cloud-providers/_index.md diff --git a/website/content/en/v0.4.3-docs/concepts/_index.md b/website/content/en/v0.4.3/concepts/_index.md similarity index 100% rename from website/content/en/v0.4.3-docs/concepts/_index.md rename to website/content/en/v0.4.3/concepts/_index.md diff --git a/website/content/en/v0.4.3-docs/development-guide.md b/website/content/en/v0.4.3/development-guide.md similarity index 92% rename from website/content/en/v0.4.3-docs/development-guide.md rename to website/content/en/v0.4.3/development-guide.md index 85976f54ee78..d65bb1526e9d 100644 --- a/website/content/en/v0.4.3-docs/development-guide.md +++ b/website/content/en/v0.4.3/development-guide.md @@ -34,7 +34,6 @@ make delete # Uninstall Karpenter * Make sure you have valid credentials to your development repository. * `$KO_DOCKER_REPO` must point to your development repository * Your cluster must have permissions to read from the repository -* If you created your cluster on version 1.19 or above, you may need to tag your subnets as mentioned [here]({{< ref "/docs/getting-started/_index.md#tag-subnets" >}}). This is a temporary problem with our subnet discovery system, and is being tracked [here](https://github.com/aws/karpenter/issues/404#issuecomment-845283904). * It's also a good idea to persist `$CLOUD_PROVIDER` in your environment variables to simplify the `make apply` command. ### Build and Deploy diff --git a/website/content/en/v0.4.3-docs/faqs.md b/website/content/en/v0.4.3/faqs.md similarity index 100% rename from website/content/en/v0.4.3-docs/faqs.md rename to website/content/en/v0.4.3/faqs.md diff --git a/website/content/en/v0.4.3-docs/getting-started/_index.md b/website/content/en/v0.4.3/getting-started/_index.md similarity index 100% rename from website/content/en/v0.4.3-docs/getting-started/_index.md rename to website/content/en/v0.4.3/getting-started/_index.md diff --git a/website/content/en/v0.4.3-docs/getting-started/cloudformation.yaml b/website/content/en/v0.4.3/getting-started/cloudformation.yaml similarity index 100% rename from website/content/en/v0.4.3-docs/getting-started/cloudformation.yaml rename to website/content/en/v0.4.3/getting-started/cloudformation.yaml diff --git a/website/content/en/v0.4.3-docs/getting-started/grafana-values.yaml b/website/content/en/v0.4.3/getting-started/grafana-values.yaml similarity index 100% rename from website/content/en/v0.4.3-docs/getting-started/grafana-values.yaml rename to website/content/en/v0.4.3/getting-started/grafana-values.yaml diff --git a/website/content/en/v0.4.3-docs/getting-started/prometheus-values.yaml b/website/content/en/v0.4.3/getting-started/prometheus-values.yaml similarity index 100% rename from website/content/en/v0.4.3-docs/getting-started/prometheus-values.yaml rename to website/content/en/v0.4.3/getting-started/prometheus-values.yaml diff --git a/website/content/en/v0.4.3-docs/provisioner-crd.md b/website/content/en/v0.4.3/provisioner-crd.md similarity index 100% rename from website/content/en/v0.4.3-docs/provisioner-crd.md rename to website/content/en/v0.4.3/provisioner-crd.md diff --git a/website/content/en/v0.5.0-docs/AWS/_index.md b/website/content/en/v0.5.0/AWS/_index.md similarity index 100% rename from website/content/en/v0.5.0-docs/AWS/_index.md rename to website/content/en/v0.5.0/AWS/_index.md diff --git a/website/content/en/v0.5.0-docs/AWS/launch-templates.md b/website/content/en/v0.5.0/AWS/launch-templates.md similarity index 100% rename from website/content/en/v0.5.0-docs/AWS/launch-templates.md rename to website/content/en/v0.5.0/AWS/launch-templates.md diff --git a/website/content/en/v0.5.0-docs/AWS/provisioning.md b/website/content/en/v0.5.0/AWS/provisioning.md similarity index 100% rename from website/content/en/v0.5.0-docs/AWS/provisioning.md rename to website/content/en/v0.5.0/AWS/provisioning.md diff --git a/website/content/en/v0.5.0-docs/_index.md b/website/content/en/v0.5.0/_index.md similarity index 100% rename from website/content/en/v0.5.0-docs/_index.md rename to website/content/en/v0.5.0/_index.md diff --git a/website/content/en/v0.5.0-docs/concepts/_index.md b/website/content/en/v0.5.0/concepts/_index.md similarity index 100% rename from website/content/en/v0.5.0-docs/concepts/_index.md rename to website/content/en/v0.5.0/concepts/_index.md diff --git a/website/content/en/v0.5.3-docs/development-guide.md b/website/content/en/v0.5.0/development-guide.md similarity index 92% rename from website/content/en/v0.5.3-docs/development-guide.md rename to website/content/en/v0.5.0/development-guide.md index 921661900f91..2935246847a0 100644 --- a/website/content/en/v0.5.3-docs/development-guide.md +++ b/website/content/en/v0.5.0/development-guide.md @@ -34,7 +34,6 @@ make delete # Uninstall Karpenter * Make sure you have valid credentials to your development repository. * `$KO_DOCKER_REPO` must point to your development repository * Your cluster must have permissions to read from the repository -* If you created your cluster on version 1.19 or above, you may need to tag your subnets as mentioned [here]({{< ref "/docs/getting-started/_index.md#tag-subnets" >}}). This is a temporary problem with our subnet discovery system, and is being tracked [here](https://github.com/aws/karpenter/issues/404#issuecomment-845283904). * It's also a good idea to persist `$CLOUD_PROVIDER` in your environment variables to simplify the `make apply` command. ### Build and Deploy diff --git a/website/content/en/v0.5.0-docs/getting-started/_index.md b/website/content/en/v0.5.0/getting-started/_index.md similarity index 100% rename from website/content/en/v0.5.0-docs/getting-started/_index.md rename to website/content/en/v0.5.0/getting-started/_index.md diff --git a/website/content/en/v0.5.0-docs/getting-started/cloudformation.yaml b/website/content/en/v0.5.0/getting-started/cloudformation.yaml similarity index 100% rename from website/content/en/v0.5.0-docs/getting-started/cloudformation.yaml rename to website/content/en/v0.5.0/getting-started/cloudformation.yaml diff --git a/website/content/en/v0.5.0-docs/provisioner.md b/website/content/en/v0.5.0/provisioner.md similarity index 100% rename from website/content/en/v0.5.0-docs/provisioner.md rename to website/content/en/v0.5.0/provisioner.md diff --git a/website/content/en/v0.5.0-docs/reinvent.md b/website/content/en/v0.5.0/reinvent.md similarity index 100% rename from website/content/en/v0.5.0-docs/reinvent.md rename to website/content/en/v0.5.0/reinvent.md diff --git a/website/content/en/v0.5.0-docs/tasks/_index.md b/website/content/en/v0.5.0/tasks/_index.md similarity index 100% rename from website/content/en/v0.5.0-docs/tasks/_index.md rename to website/content/en/v0.5.0/tasks/_index.md diff --git a/website/content/en/v0.5.0-docs/tasks/deprov-nodes.md b/website/content/en/v0.5.0/tasks/deprov-nodes.md similarity index 100% rename from website/content/en/v0.5.0-docs/tasks/deprov-nodes.md rename to website/content/en/v0.5.0/tasks/deprov-nodes.md diff --git a/website/content/en/v0.5.0-docs/tasks/provisioning-task.md b/website/content/en/v0.5.0/tasks/provisioning-task.md similarity index 100% rename from website/content/en/v0.5.0-docs/tasks/provisioning-task.md rename to website/content/en/v0.5.0/tasks/provisioning-task.md diff --git a/website/content/en/v0.5.0-docs/tasks/running-pods.md b/website/content/en/v0.5.0/tasks/running-pods.md similarity index 100% rename from website/content/en/v0.5.0-docs/tasks/running-pods.md rename to website/content/en/v0.5.0/tasks/running-pods.md diff --git a/website/content/en/v0.5.2-docs/AWS/_index.md b/website/content/en/v0.5.2/AWS/_index.md similarity index 100% rename from website/content/en/v0.5.2-docs/AWS/_index.md rename to website/content/en/v0.5.2/AWS/_index.md diff --git a/website/content/en/v0.5.2-docs/AWS/launch-templates.md b/website/content/en/v0.5.2/AWS/launch-templates.md similarity index 100% rename from website/content/en/v0.5.2-docs/AWS/launch-templates.md rename to website/content/en/v0.5.2/AWS/launch-templates.md diff --git a/website/content/en/v0.5.2-docs/AWS/provisioning.md b/website/content/en/v0.5.2/AWS/provisioning.md similarity index 100% rename from website/content/en/v0.5.2-docs/AWS/provisioning.md rename to website/content/en/v0.5.2/AWS/provisioning.md diff --git a/website/content/en/v0.5.2-docs/_index.md b/website/content/en/v0.5.2/_index.md similarity index 100% rename from website/content/en/v0.5.2-docs/_index.md rename to website/content/en/v0.5.2/_index.md diff --git a/website/content/en/v0.5.2-docs/concepts/_index.md b/website/content/en/v0.5.2/concepts/_index.md similarity index 100% rename from website/content/en/v0.5.2-docs/concepts/_index.md rename to website/content/en/v0.5.2/concepts/_index.md diff --git a/website/content/en/docs/development-guide.md b/website/content/en/v0.5.2/development-guide.md similarity index 92% rename from website/content/en/docs/development-guide.md rename to website/content/en/v0.5.2/development-guide.md index 921661900f91..2935246847a0 100644 --- a/website/content/en/docs/development-guide.md +++ b/website/content/en/v0.5.2/development-guide.md @@ -34,7 +34,6 @@ make delete # Uninstall Karpenter * Make sure you have valid credentials to your development repository. * `$KO_DOCKER_REPO` must point to your development repository * Your cluster must have permissions to read from the repository -* If you created your cluster on version 1.19 or above, you may need to tag your subnets as mentioned [here]({{< ref "/docs/getting-started/_index.md#tag-subnets" >}}). This is a temporary problem with our subnet discovery system, and is being tracked [here](https://github.com/aws/karpenter/issues/404#issuecomment-845283904). * It's also a good idea to persist `$CLOUD_PROVIDER` in your environment variables to simplify the `make apply` command. ### Build and Deploy diff --git a/website/content/en/v0.5.2-docs/getting-started/_index.md b/website/content/en/v0.5.2/getting-started/_index.md similarity index 100% rename from website/content/en/v0.5.2-docs/getting-started/_index.md rename to website/content/en/v0.5.2/getting-started/_index.md diff --git a/website/content/en/v0.5.2-docs/getting-started/cloudformation.yaml b/website/content/en/v0.5.2/getting-started/cloudformation.yaml similarity index 100% rename from website/content/en/v0.5.2-docs/getting-started/cloudformation.yaml rename to website/content/en/v0.5.2/getting-started/cloudformation.yaml diff --git a/website/content/en/v0.5.2-docs/provisioner.md b/website/content/en/v0.5.2/provisioner.md similarity index 100% rename from website/content/en/v0.5.2-docs/provisioner.md rename to website/content/en/v0.5.2/provisioner.md diff --git a/website/content/en/v0.5.2-docs/reinvent.md b/website/content/en/v0.5.2/reinvent.md similarity index 100% rename from website/content/en/v0.5.2-docs/reinvent.md rename to website/content/en/v0.5.2/reinvent.md diff --git a/website/content/en/v0.5.2-docs/tasks/_index.md b/website/content/en/v0.5.2/tasks/_index.md similarity index 100% rename from website/content/en/v0.5.2-docs/tasks/_index.md rename to website/content/en/v0.5.2/tasks/_index.md diff --git a/website/content/en/v0.5.2-docs/tasks/deprov-nodes.md b/website/content/en/v0.5.2/tasks/deprov-nodes.md similarity index 100% rename from website/content/en/v0.5.2-docs/tasks/deprov-nodes.md rename to website/content/en/v0.5.2/tasks/deprov-nodes.md diff --git a/website/content/en/v0.5.2-docs/tasks/provisioning-task.md b/website/content/en/v0.5.2/tasks/provisioning-task.md similarity index 100% rename from website/content/en/v0.5.2-docs/tasks/provisioning-task.md rename to website/content/en/v0.5.2/tasks/provisioning-task.md diff --git a/website/content/en/v0.5.2-docs/tasks/running-pods.md b/website/content/en/v0.5.2/tasks/running-pods.md similarity index 100% rename from website/content/en/v0.5.2-docs/tasks/running-pods.md rename to website/content/en/v0.5.2/tasks/running-pods.md diff --git a/website/content/en/v0.5.3-docs/AWS/_index.md b/website/content/en/v0.5.3/AWS/_index.md similarity index 100% rename from website/content/en/v0.5.3-docs/AWS/_index.md rename to website/content/en/v0.5.3/AWS/_index.md diff --git a/website/content/en/v0.5.3-docs/AWS/launch-templates.md b/website/content/en/v0.5.3/AWS/launch-templates.md similarity index 100% rename from website/content/en/v0.5.3-docs/AWS/launch-templates.md rename to website/content/en/v0.5.3/AWS/launch-templates.md diff --git a/website/content/en/v0.5.3-docs/AWS/provisioning.md b/website/content/en/v0.5.3/AWS/provisioning.md similarity index 100% rename from website/content/en/v0.5.3-docs/AWS/provisioning.md rename to website/content/en/v0.5.3/AWS/provisioning.md diff --git a/website/content/en/v0.5.3-docs/_index.md b/website/content/en/v0.5.3/_index.md similarity index 98% rename from website/content/en/v0.5.3-docs/_index.md rename to website/content/en/v0.5.3/_index.md index d506b3fbaa3c..54969b228174 100755 --- a/website/content/en/v0.5.3-docs/_index.md +++ b/website/content/en/v0.5.3/_index.md @@ -3,6 +3,8 @@ title: "Documentation" linkTitle: "Docs" weight: 20 +aliases: + - docs cascade: type: docs --- diff --git a/website/content/en/v0.5.3-docs/concepts/_index.md b/website/content/en/v0.5.3/concepts/_index.md similarity index 100% rename from website/content/en/v0.5.3-docs/concepts/_index.md rename to website/content/en/v0.5.3/concepts/_index.md diff --git a/website/content/en/v0.5.0-docs/development-guide.md b/website/content/en/v0.5.3/development-guide.md similarity index 92% rename from website/content/en/v0.5.0-docs/development-guide.md rename to website/content/en/v0.5.3/development-guide.md index 921661900f91..2935246847a0 100644 --- a/website/content/en/v0.5.0-docs/development-guide.md +++ b/website/content/en/v0.5.3/development-guide.md @@ -34,7 +34,6 @@ make delete # Uninstall Karpenter * Make sure you have valid credentials to your development repository. * `$KO_DOCKER_REPO` must point to your development repository * Your cluster must have permissions to read from the repository -* If you created your cluster on version 1.19 or above, you may need to tag your subnets as mentioned [here]({{< ref "/docs/getting-started/_index.md#tag-subnets" >}}). This is a temporary problem with our subnet discovery system, and is being tracked [here](https://github.com/aws/karpenter/issues/404#issuecomment-845283904). * It's also a good idea to persist `$CLOUD_PROVIDER` in your environment variables to simplify the `make apply` command. ### Build and Deploy diff --git a/website/content/en/v0.5.3-docs/getting-started-with-kops/_index.md b/website/content/en/v0.5.3/getting-started-with-kops/_index.md similarity index 100% rename from website/content/en/v0.5.3-docs/getting-started-with-kops/_index.md rename to website/content/en/v0.5.3/getting-started-with-kops/_index.md diff --git a/website/content/en/v0.5.3-docs/getting-started-with-terraform/_index.md b/website/content/en/v0.5.3/getting-started-with-terraform/_index.md similarity index 100% rename from website/content/en/v0.5.3-docs/getting-started-with-terraform/_index.md rename to website/content/en/v0.5.3/getting-started-with-terraform/_index.md diff --git a/website/content/en/docs/getting-started/_index.md b/website/content/en/v0.5.3/getting-started/_index.md similarity index 99% rename from website/content/en/docs/getting-started/_index.md rename to website/content/en/v0.5.3/getting-started/_index.md index 54c83fea6e0a..df23ae19ef96 100644 --- a/website/content/en/docs/getting-started/_index.md +++ b/website/content/en/v0.5.3/getting-started/_index.md @@ -3,9 +3,6 @@ title: "Getting Started with Karpenter on AWS" linkTitle: "Getting Started" weight: 10 -menu: - main: - weight: 10 --- Karpenter automatically provisions new nodes in response to unschedulable diff --git a/website/content/en/v0.5.3-docs/getting-started/cloudformation.yaml b/website/content/en/v0.5.3/getting-started/cloudformation.yaml similarity index 100% rename from website/content/en/v0.5.3-docs/getting-started/cloudformation.yaml rename to website/content/en/v0.5.3/getting-started/cloudformation.yaml diff --git a/website/content/en/v0.5.3-docs/getting-started/grafana-values.yaml b/website/content/en/v0.5.3/getting-started/grafana-values.yaml similarity index 100% rename from website/content/en/v0.5.3-docs/getting-started/grafana-values.yaml rename to website/content/en/v0.5.3/getting-started/grafana-values.yaml diff --git a/website/content/en/v0.5.3-docs/getting-started/prometheus-values.yaml b/website/content/en/v0.5.3/getting-started/prometheus-values.yaml similarity index 100% rename from website/content/en/v0.5.3-docs/getting-started/prometheus-values.yaml rename to website/content/en/v0.5.3/getting-started/prometheus-values.yaml diff --git a/website/content/en/v0.5.3-docs/provisioner.md b/website/content/en/v0.5.3/provisioner.md similarity index 92% rename from website/content/en/v0.5.3-docs/provisioner.md rename to website/content/en/v0.5.3/provisioner.md index d88bb50455a2..b636c7850cf1 100644 --- a/website/content/en/v0.5.3-docs/provisioner.md +++ b/website/content/en/v0.5.3/provisioner.md @@ -2,7 +2,6 @@ title: "Provisioner API" linkTitle: "Provisioner API" weight: 70 -date: 2017-01-05 description: > Provisioner API reference page --- @@ -35,13 +34,13 @@ spec: # These requirements are combined with pod.spec.affinity.nodeAffinity rules. # Operators { In, NotIn } are supported to enable including or excluding values requirements: - - key: "node.kubernetes.io/instance-type" + - key: "node.kubernetes.io/instance-type" operator: In values: ["m5.large", "m5.2xlarge"] - - key: "topology.kubernetes.io/zone" + - key: "topology.kubernetes.io/zone" operator: In values: ["us-west-2a", "us-west-2b"] - - key: "kubernetes.io/arch" + - key: "kubernetes.io/arch" operator: In values: ["arm64", "amd64"] - key: "karpenter.sh/capacity-type" # If not included, the webhook for the AWS cloud provider will default to on-demand @@ -53,19 +52,19 @@ spec: ## spec.requirements -Kubernetes defines the following [Well-Known Labels](https://kubernetes.io/docs/reference/labels-annotations-taints/), and cloud providers (e.g., AWS) implement them. They are defined at the "spec.requirements" section of the Provisioner API. +Kubernetes defines the following [Well-Known Labels](https://kubernetes.io/docs/reference/labels-annotations-taints/), and cloud providers (e.g., AWS) implement them. They are defined at the "spec.requirements" section of the Provisioner API. These well known labels may be specified at the provisioner level, or in a workload definition (e.g., nodeSelector on a pod.spec). Nodes are chosen using the both the provisioner's and pod's requirements. If there is no overlap, nodes will not be launched. In other words, a pod's requirements must be within the provisioner's requirements. If a requirement is not defined for a well known label, any value available to the cloud provider may be chosen. -For example, an instance type may be specified using a nodeSelector in a pod spec. If the instance type requested is not included in the provisioner list and the provisioner has instance type requirements, Karpenter will not create a node or schedule the pod. +For example, an instance type may be specified using a nodeSelector in a pod spec. If the instance type requested is not included in the provisioner list and the provisioner has instance type requirements, Karpenter will not create a node or schedule the pod. -📝 None of these values are required. +📝 None of these values are required. ### Instance Types - key: `node.kubernetes.io/instance-type` -Generally, instance types should be a list and not a single value. Leaving this field undefined is recommended, as it maximizes choices for efficiently placing pods. +Generally, instance types should be a list and not a single value. Leaving this field undefined is recommended, as it maximizes choices for efficiently placing pods. ☁️ **AWS** @@ -132,14 +131,14 @@ Karpenter supports `amd64` nodes, and `arm64` nodes. - values - `spot` (default) - - `on-demand` + - `on-demand` Karpenter supports specifying capacity type, which is analogous to [EC2 purchase options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html). ## spec.kubeletConfiguration -Karpenter provides the ability to specify a few additional Kubelet args. These are all optional and provide support for +Karpenter provides the ability to specify a few additional Kubelet args. These are all optional and provide support for additional customization and use cases. Adjust these only if you know you need to do so. ```yaml @@ -154,6 +153,3 @@ spec: This section is cloud provider specific. Reference the appropriate documentation: - [AWS](../aws/provisioning/) - - - diff --git a/website/content/en/v0.5.3-docs/reinvent.md b/website/content/en/v0.5.3/reinvent.md similarity index 100% rename from website/content/en/v0.5.3-docs/reinvent.md rename to website/content/en/v0.5.3/reinvent.md diff --git a/website/content/en/v0.5.3-docs/tasks/_index.md b/website/content/en/v0.5.3/tasks/_index.md similarity index 100% rename from website/content/en/v0.5.3-docs/tasks/_index.md rename to website/content/en/v0.5.3/tasks/_index.md diff --git a/website/content/en/v0.5.3-docs/tasks/deprov-nodes.md b/website/content/en/v0.5.3/tasks/deprov-nodes.md similarity index 100% rename from website/content/en/v0.5.3-docs/tasks/deprov-nodes.md rename to website/content/en/v0.5.3/tasks/deprov-nodes.md diff --git a/website/content/en/v0.5.3-docs/tasks/provisioning-task.md b/website/content/en/v0.5.3/tasks/provisioning-task.md similarity index 100% rename from website/content/en/v0.5.3-docs/tasks/provisioning-task.md rename to website/content/en/v0.5.3/tasks/provisioning-task.md diff --git a/website/content/en/v0.5.3-docs/tasks/running-pods.md b/website/content/en/v0.5.3/tasks/running-pods.md similarity index 100% rename from website/content/en/v0.5.3-docs/tasks/running-pods.md rename to website/content/en/v0.5.3/tasks/running-pods.md diff --git a/website/layouts/partials/hooks/body-end.html b/website/layouts/partials/hooks/body-end.html index 1ee1bb5ce8d1..f069523d218e 100644 --- a/website/layouts/partials/hooks/body-end.html +++ b/website/layouts/partials/hooks/body-end.html @@ -1,14 +1,14 @@ diff --git a/website/layouts/partials/navbar-version-selector.html b/website/layouts/partials/navbar-version-selector.html index e8ca0f538600..e540b562e34a 100644 --- a/website/layouts/partials/navbar-version-selector.html +++ b/website/layouts/partials/navbar-version-selector.html @@ -1,19 +1,13 @@ {{ $pageDir := index (split (path.Dir .Page.RelPermalink) "/") 1 }} {{ if eq $pageDir "" }} - {{ $pageDir = "docs" }} -{{ end }} -{{ $currentDocVer := $pageDir }} -{{ range .Site.Params.versions }} - {{ if eq .url (printf "/%s/" $pageDir) }} - {{ $currentDocVer = .version }} - {{ end }} + {{ $pageDir = .Site.Params.latest_release_version }} {{ end }}