Skip to content

Commit

Permalink
Added preview doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Ellis Tarn authored and ellistarn committed Jan 18, 2022
1 parent 6285dfe commit 1a1a392
Show file tree
Hide file tree
Showing 85 changed files with 132 additions and 230 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ coverage.html
*.csv
website/node_modules
website/resources
website/public
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
157 changes: 0 additions & 157 deletions website/config.toml

This file was deleted.

80 changes: 80 additions & 0 deletions website/config.yaml
Original file line number Diff line number Diff line change
@@ -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: <i class='fab fa-github'></i>
2 changes: 1 addition & 1 deletion website/content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<h1 class="display-1 mt-5">Karpenter</h1>
<h3 class="display-4 font-weight-light mt-5">Just-in-time Nodes for Any Kubernetes Cluster</h3>
<div class="mt-5">
<a class="btn btn-lg btn-dark col-sm-3 mb-3 font-weight-bold get-started" href="{{< relref "docs/getting-started" >}}">
<a class="btn btn-lg btn-dark col-sm-3 mb-3 font-weight-bold get-started" href="docs">
Get Started
</a>
</div>
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
title: "Documentation"
linkTitle: "Docs"
weight: 20
menu:
main:
weight: 20
pre: <i class='fas fa-book'></i>
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.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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?
Expand Down Expand Up @@ -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?

Expand All @@ -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?

Expand All @@ -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.
Expand All @@ -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?
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 1a1a392

Please sign in to comment.