Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: remove deprecated orchestrator flags 

Removes the flags that have been deprecated or removed;

- --default-stack-orchestrator
- --kubernetes
- --kubeconfig
- --namespace
- --orchestrator

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2022-02-23 18:05:12 +01:00
parent 869370a3fe
commit 039018b6d3
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
11 changed files with 22 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/reference/commandline/context_create.md
View File

@ -21,14 +21,6 @@ cert Path to TLS certificate file
key Path to TLS key file
skip-tls-verify Skip TLS certificate validation
Kubernetes endpoint config:
NAME DESCRIPTION
from Copy Kubernetes endpoint configuration from an existing context
config-file Path to a Kubernetes config file
context-override Overrides the context set in the kubernetes config file
namespace-override Overrides the namespace set in the kubernetes config file
Example:
$ docker context create my-context \
@ -36,15 +28,9 @@ $ docker context create my-context \
--docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file"
Options:
--default-stack-orchestrator string Default orchestrator for
stack operations to use with
this context
(swarm|kubernetes|all)
--description string Description of the context
--docker stringToString set the docker endpoint
(default [])
--kubernetes stringToString set the kubernetes endpoint
(default [])
--from string Create the context from an existing context
```
@ -55,17 +41,15 @@ configuration to connect to different clusters or single nodes.
## Examples
### Create a context with a docker and kubernetes endpoint
### Create a context with a docker endpoint
To create a context from scratch provide the docker and, if required,
kubernetes options. The example below creates the context `my-context`
with a docker endpoint of `/var/run/docker.sock` and a kubernetes configuration
sourced from the file `/home/me/my-kube-config`:
with a docker endpoint of `/var/run/docker.sock`:
```console
$ docker context create \
--docker host=unix:///var/run/docker.sock \
--kubernetes config-file=/home/me/my-kube-config \
my-context
```
@ -92,32 +76,18 @@ $ source my-setup-script.sh
$ docker context create my-context
```
To source only the `docker` endpoint configuration from an existing context
To source the `docker` endpoint configuration from an existing context
use the `--docker from=<context-name>` option. The example below creates a
new context named `my-context` using the docker endpoint configuration from
the existing context `existing-context` and a kubernetes configuration sourced
from the file `/home/me/my-kube-config`:
the existing context `existing-context`:
```console
$ docker context create \
--docker from=existing-context \
--kubernetes config-file=/home/me/my-kube-config \
my-context
```
To source only the `kubernetes` configuration from an existing context use the
`--kubernetes from=<context-name>` option. The example below creates a new
context named `my-context` using the kuberentes configuration from the existing
context `existing-context` and a docker endpoint of `/var/run/docker.sock`:
```console
$ docker context create \
--docker host=unix:///var/run/docker.sock \
--kubernetes from=existing-context \
my-context
```
Docker and Kubernetes endpoints configurations, as well as default stack
orchestrator and description can be modified with `docker context update`.
Docker endpoints configurations, as well as the description can be modified with
`docker context update`.
Refer to the [`docker context update` reference](context_update.md) for details.

17
docs/reference/commandline/context_export.md
View File

@ -9,15 +9,16 @@ keywords: "context, export"
```markdown
Usage: docker context export [OPTIONS] CONTEXT [FILE|-]
Export a context to a tar or kubeconfig file
Options:
--kubeconfig Export as a kubeconfig file
Export a context to a tar archive FILE or a tar stream on STDOUT.
```
## Description
Exports a context in a file that can then be used with `docker context import`
(or with `kubectl` if `--kubeconfig` is set). Default output filename is
`<CONTEXT>.dockercontext`, or `<CONTEXT>.kubeconfig` if `--kubeconfig` is set.
To export to `STDOUT`, you can run `docker context export my-context -`.
Exports a context to a file that can then be used with `docker context import`.
The default output filename is `<CONTEXT>.dockercontext`. To export to `STDOUT`,
use `-` as filename, for example:
```console
$ docker context export my-context -
```

17
docs/reference/commandline/context_inspect.md
View File

@ -30,27 +30,16 @@ $ docker context inspect "local+aks"
{
"Name": "local+aks",
"Metadata": {
"Description": "Local Docker Engine + Azure AKS endpoint",
"StackOrchestrator": "kubernetes"
"Description": "Local Docker Engine",
"StackOrchestrator": "swarm"
},
"Endpoints": {
"docker": {
"Host": "npipe:////./pipe/docker_engine",
"SkipTLSVerify": false
},
"kubernetes": {
"Host": "https://simon-aks-***.hcp.uksouth.azmk8s.io:443",
"SkipTLSVerify": false,
"DefaultNamespace": "default"
}
},
"TLSMaterial": {
"kubernetes": [
"ca.pem",
"cert.pem",
"key.pem"
]
},
"TLSMaterial": {},
"Storage": {
"MetadataPath": "C:\\Users\\simon\\.docker\\contexts\\meta\\cb6d08c0a1bfa5fe6f012e61a442788c00bed93f509141daff05f620fc54ddee",
"TLSPath": "C:\\Users\\simon\\.docker\\contexts\\tls\\cb6d08c0a1bfa5fe6f012e61a442788c00bed93f509141daff05f620fc54ddee"

14
docs/reference/commandline/context_update.md
View File

@ -21,28 +21,14 @@ cert Path to TLS certificate file
key Path to TLS key file
skip-tls-verify Skip TLS certificate validation
Kubernetes endpoint config:
NAME DESCRIPTION
from Copy Kubernetes endpoint configuration from an existing context
config-file Path to a Kubernetes config file
context-override Overrides the context set in the kubernetes config file
namespace-override Overrides the namespace set in the kubernetes config file
Example:
$ docker context update my-context --description "some description" --docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file"
Options:
--default-stack-orchestrator string Default orchestrator for
stack operations to use with
this context
(swarm|kubernetes|all)
--description string Description of the context
--docker stringToString set the docker endpoint
(default [])
--kubernetes stringToString set the kubernetes endpoint
(default [])
```
## Description

2
docs/reference/commandline/stack.md
View File

@ -13,8 +13,6 @@ Manage Docker stacks
Options:
--help Print usage
--kubeconfig string Kubernetes config file
--orchestrator string Orchestrator to use (swarm|kubernetes|all)
Commands:
deploy Deploy a new stack or update an existing stack

3
docs/reference/commandline/stack_deploy.md
View File

@ -17,9 +17,6 @@ Aliases:
Options:
-c, --compose-file strings Path to a Compose file, or "-" to read from stdin
--help Print usage
--kubeconfig string Kubernetes config file
--namespace string Kubernetes namespace to use
--orchestrator string Orchestrator to use (swarm|kubernetes|all)
--prune Prune services that are no longer referenced
--resolve-image string Query the registry to resolve image digest and supported platforms
("always"|"changed"|"never") (default "always")

3
docs/reference/commandline/stack_ls.md
View File

@ -17,9 +17,6 @@ Aliases:
Options:
--help Print usage
--format string Pretty-print stacks using a Go template
--kubeconfig string Kubernetes config file
--namespace string Kubernetes namespace to use
--orchestrator string Orchestrator to use (swarm|kubernetes|all)
```
## Description

3
docs/reference/commandline/stack_ps.md
View File

@ -15,11 +15,8 @@ Options:
-f, --filter filter Filter output based on conditions provided
--format string Pretty-print tasks using a Go template
--help Print usage
--kubeconfig string Kubernetes config file
--namespace string Kubernetes namespace to use
--no-resolve Do not map IDs to Names
--no-trunc Do not truncate output
--orchestrator string Orchestrator to use (swarm|kubernetes|all)
-q, --quiet Only display task IDs
```

9
docs/reference/commandline/stack_rm.md
View File

@ -16,9 +16,6 @@ Aliases:
Options:
--help Print usage
--kubeconfig string Kubernetes config file
--namespace string Kubernetes namespace to use
--orchestrator string Orchestrator to use (swarm|kubernetes|all)
```
## Description
@ -36,7 +33,8 @@ Remove the stack from the swarm.
### Remove a stack
This will remove the stack with the name `myapp`. Services, networks, and secrets associated with the stack will be removed.
This will remove the stack with the name `myapp`. Services, networks, and secrets
associated with the stack will be removed.
```console
$ docker stack rm myapp
@ -50,7 +48,8 @@ Removing network myapp_frontend
### Remove multiple stacks
This will remove all the specified stacks, `myapp` and `vossibility`. Services, networks, and secrets associated with all the specified stacks will be removed.
This will remove all the specified stacks, `myapp` and `vossibility`. Services,
networks, and secrets associated with all the specified stacks will be removed.
```console
$ docker stack rm myapp vossibility

3
docs/reference/commandline/stack_services.md
View File

@ -15,9 +15,6 @@ Options:
-f, --filter filter Filter output based on conditions provided
--format string Pretty-print services using a Go template
--help Print usage
--kubeconfig string Kubernetes config file
--namespace string Kubernetes namespace to use
--orchestrator string Orchestrator to use (swarm|kubernetes|all)
-q, --quiet Only display IDs
```

1
docs/reference/commandline/version.md
View File

@ -14,7 +14,6 @@ Show the Docker version information
Options:
-f, --format string Format the output using the given Go template
--help Print usage
--kubeconfig string Kubernetes config file
```
## Description