-
Notifications
You must be signed in to change notification settings - Fork 771
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs and changelog for v0.6.1 (#388)
Signed-off-by: Siyu Wang <[email protected]>
- Loading branch information
Showing
17 changed files
with
3,433 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Patterns to ignore when building packages. | ||
| # This supports shell glob matching, relative path matching, and | ||
| # negation (prefixed with !). Only one pattern per line. | ||
| .DS_Store | ||
| # Common VCS dirs | ||
| .git/ | ||
| .gitignore | ||
| .bzr/ | ||
| .bzrignore | ||
| .hg/ | ||
| .hgignore | ||
| .svn/ | ||
| # Common backup files | ||
| *.swp | ||
| *.bak | ||
| *.tmp | ||
| *~ | ||
| # Various IDEs | ||
| .project | ||
| .idea/ | ||
| *.tmproj |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| apiVersion: v1 | ||
| name: kruise | ||
| description: Helm chart for all kruise-manager components | ||
| version: 0.6.1 | ||
| appVersion: 0.6.1 | ||
| icon: http://openkruise.io/img/kruise_white.png | ||
| keywords: | ||
| - kubernetes | ||
| - kruise | ||
| - workload | ||
| - statefulset | ||
| - sidecar | ||
| - job | ||
| - deployment | ||
| home: https://openkruise.io | ||
| sources: | ||
| - https://github.com/openkruise/kruise |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Kruise | ||
|
|
||
| ## Install | ||
|
|
||
| Install with Helm 3: | ||
|
|
||
| If your Kubernetes version is lower than 1.15 and you'd like to install Kruise via Helm 3, you'll need Helm v3.1.0+ that has the flag --disable-openapi-validation. | ||
|
|
||
| ```bash | ||
| # Kubernetes 1.14 and older versions | ||
| helm install kruise https://github.com/openkruise/kruise/releases/download/v0.6.1/kruise-chart.tgz --disable-openapi-validation | ||
| # Kubernetes 1.15 and newer versions | ||
| helm install kruise https://github.com/openkruise/kruise/releases/download/v0.6.1/kruise-chart.tgz | ||
| ``` | ||
|
|
||
| you will see follow: | ||
|
|
||
| ``` | ||
| NAME: kruise | ||
| LAST DEPLOYED: Mon Jan 6 14:47:48 2020 | ||
| NAMESPACE: default | ||
| STATUS: deployed | ||
| REVISION: 1 | ||
| TEST SUITE: None | ||
| ``` | ||
|
|
||
| ## Uninstall | ||
|
|
||
| ```bash | ||
| $ helm delete kruise | ||
| release "kruise" uninstalled | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following table lists the configurable parameters of the kruise chart and their default values. | ||
|
|
||
| | Parameter | Description | Default | | ||
| | ----------------------------------------- | ------------------------------------------------------------ | ----------------------------- | | ||
| | `log.level` | Log level that kruise-manager printed | `4` | | ||
| | `revisionHistoryLimit` | Limit of revision history | `3` | | ||
| | `manager.replicas` | Replicas of kruise-controller-manager deployment | `2` | | ||
| | `manager.image.repository` | Repository for kruise-manager image | `openkruise/kruise-manager` | | ||
| | `manager.image.tag` | Tag for kruise-manager image | `v0.6.1` | | ||
| | `manager.resources.limits.cpu` | CPU resource limit of kruise-manager container | `100m` | | ||
| | `manager.resources.limits.memory` | Memory resource limit of kruise-manager container | `256Mi` | | ||
| | `manager.resources.requests.cpu` | CPU resource request of kruise-manager container | `100m` | | ||
| | `manager.resources.requests.memory` | Memory resource request of kruise-manager container | `256Mi` | | ||
| | `manager.metrics.addr` | Addr of metrics served | `localhost` | | ||
| | `manager.metrics.port` | Port of metrics served | `8080` | | ||
| | `manager.webhook.port` | Port of webhook served | `9443` | | ||
| | `manager.custom_resource_enable` | Custom resources enabled by kruise-manager | `""(empty means all enabled)` | | ||
| | `spec.nodeAffinity` | Node affinity policy for kruise-manager pod | `{}` | | ||
| | `spec.nodeSelector` | Node labels for kruise-manager pod | `{}` | | ||
| | `spec.tolerations` | Tolerations for kruise-manager pod | `[]` | | ||
| | `webhookConfiguration.failurePolicy.pods` | The failurePolicy for pods in mutating webhook configuration | `Ignore` | | ||
|
|
||
| Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, | ||
|
|
||
| ```bash | ||
| # helm install kruise https://github.com/openkruise/kruise/releases/download/v0.6.1/kruise-chart.tgz --set manager.log.level=5,manager.custom_resource_enable="CloneSet\,SidecarSet" | ||
| ``` |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| {{/* vim: set filetype=mustache: */}} | ||
| {{/* | ||
| Expand the name of the chart. | ||
| */}} | ||
| {{- define "kruise.name" -}} | ||
| {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Create a default fully qualified app name. | ||
| We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). | ||
| If release name contains chart name it will be used as a full name. | ||
| */}} | ||
| {{- define "kruise.fullname" -}} | ||
| {{- if .Values.fullnameOverride -}} | ||
| {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} | ||
| {{- else -}} | ||
| {{- $name := default .Chart.Name .Values.nameOverride -}} | ||
| {{- if contains $name .Release.Name -}} | ||
| {{- .Release.Name | trunc 63 | trimSuffix "-" -}} | ||
| {{- else -}} | ||
| {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Create chart name and version as used by the chart label. | ||
| */}} | ||
| {{- define "kruise.chart" -}} | ||
| {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} | ||
| {{- end -}} |
Oops, something went wrong.