forked from kubernetes-sigs/descheduler
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request kubernetes-sigs#244 from KohlsTechnology/docs-revamp
Documentation Refresh
- Loading branch information
Showing
5 changed files
with
192 additions
and
86 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Documentation Index | ||
|
||
- [Contributor Guide](contributor-guide.md) | ||
- [Release Guide](release-guide.md) | ||
- [User Guide](user-guide.md) |
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,42 @@ | ||
# Contributor Guide | ||
|
||
## Required Tools | ||
|
||
- [Git](https://git-scm.com/downloads) | ||
- [Go 1.13+](https://golang.org/dl/) | ||
- [Docker](https://docs.docker.com/install/) | ||
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl) | ||
- [kind](https://kind.sigs.k8s.io/) | ||
|
||
## Build and Run | ||
|
||
Build descheduler. | ||
```sh | ||
cd $GOPATH/src/sigs.k8s.io | ||
git clone https://github.com/kubernetes-sigs/descheduler.git | ||
cd descheduler | ||
make | ||
``` | ||
|
||
Run descheduler. | ||
```sh | ||
./_output/bin/descheduler --kubeconfig <path to kubeconfig> --policy-config-file <path-to-policy-file> --v 1 | ||
``` | ||
|
||
View all CLI options. | ||
``` | ||
./_output/bin/descheduler --help | ||
``` | ||
|
||
## Run Tests | ||
``` | ||
GOOS=linux make dev-image | ||
kind create cluster --config hack/kind_config.yaml | ||
kind load docker-image <image name> | ||
kind get kubeconfig > /tmp/admin.conf | ||
make test-unit | ||
make test-e2e | ||
``` | ||
|
||
### Miscellaneous | ||
See the [hack directory](https://github.com/kubernetes-sigs/descheduler/tree/master/hack) for additional tools and scripts used for developing the descheduler. |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Release process | ||
# Release Guide | ||
|
||
## Semi-automatic | ||
|
||
|
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,47 @@ | ||
# User Guide | ||
|
||
Starting with descheduler release v0.10.0 container images are available in these container registries. | ||
* `asia.gcr.io/k8s-artifacts-prod/descheduler/descheduler` | ||
* `eu.gcr.io/k8s-artifacts-prod/descheduler/descheduler` | ||
* `us.gcr.io/k8s-artifacts-prod/descheduler/descheduler` | ||
|
||
The [examples](https://github.com/kubernetes-sigs/descheduler/tree/master/examples) directory has descheduler policy configuration examples. | ||
|
||
The descheduler has many CLI options that can be used to override its default behavior. | ||
``` | ||
descheduler --help | ||
The descheduler evicts pods which may be bound to less desired nodes | ||
Usage: | ||
descheduler [flags] | ||
descheduler [command] | ||
Available Commands: | ||
help Help about any command | ||
version Version of descheduler | ||
Flags: | ||
--add-dir-header If true, adds the file directory to the header | ||
--alsologtostderr log to standard error as well as files | ||
--descheduling-interval duration Time interval between two consecutive descheduler executions. Setting this value instructs the descheduler to run in a continuous loop at the interval specified. | ||
--dry-run execute descheduler in dry run mode. | ||
--evict-local-storage-pods Enables evicting pods using local storage by descheduler | ||
-h, --help help for descheduler | ||
--kubeconfig string File with kube configuration. | ||
--log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0) | ||
--log-dir string If non-empty, write log files in this directory | ||
--log-file string If non-empty, use this log file | ||
--log-file-max-size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800) | ||
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s) | ||
--logtostderr log to standard error instead of files (default true) | ||
--max-pods-to-evict-per-node int Limits the maximum number of pods to be evicted per node by descheduler | ||
--node-selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) | ||
--policy-config-file string File with descheduler policy configuration. | ||
--skip-headers If true, avoid header prefixes in the log messages | ||
--skip-log-headers If true, avoid headers when opening log files | ||
--stderrthreshold severity logs at or above this threshold go to stderr (default 2) | ||
-v, --v Level number for the log level verbosity | ||
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging | ||
Use "descheduler [command] --help" for more information about a command. | ||
``` |