mirror of https://github.com/docker/docs.git
Merge pull request #8980 from ollypom/ucp318configfilepatch
Added UCP 3.1.8 Configuration file and CLI reference
This commit is contained in:
Usha Mandya
GitHub
commit
7fac809ba8
|
|
@ -93,17 +93,6 @@ An array of tables that specifies the DTR instances that the current UCP instanc
|
|||
| `service_id` | yes | The DTR instance's OpenID Connect Client ID, as registered with the Docker authentication provider. |
|
||||
| `ca_bundle` | no | If you're using a custom certificate authority (CA), `ca_bundle` specifies the root CA bundle for the DTR instance. The value is a string with the contents of a `ca.pem` file. |
|
||||
|
||||
### custom headers (optional)
|
||||
|
||||
Included when you need to set custom API headers. You can repeat this section multiple times to specify multiple separate headers. If you include custom headers, you must specify both `name` and `value`.
|
||||
|
||||
[[custom_api_server_headers]]
|
||||
|
||||
| Item | Description |
|
||||
| ----------- | ----------- |
|
||||
| `name` | Set to specify the name of the custom header with `name` = "*X-Custom-Header-Name*". |
|
||||
| `value` | Set to specify the value of the custom header with `value` = "*Custom Header Value*". |
|
||||
|
||||
|
||||
### audit_log_configuration table (optional)
|
||||
Configures audit logging options for UCP components.
|
||||
|
|
@ -165,6 +154,29 @@ Specifies whether the your UCP license is automatically renewed.
|
|||
|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `auto_refresh` | no | Set to `true` to enable attempted automatic license renewal when the license nears expiration. If disabled, you must manually upload renewed license after expiration. The default is `true`. |
|
||||
|
||||
### custom headers (optional)
|
||||
|
||||
Included when you need to set custom API headers. You can repeat this section multiple times to specify multiple separate headers. If you include custom headers, you must specify both `name` and `value`.
|
||||
|
||||
[[custom_api_server_headers]]
|
||||
|
||||
| Item | Description |
|
||||
|:--------|:--------------------------------------------------------------------------------------|
|
||||
| `name` | Set to specify the name of the custom header with `name` = "*X-Custom-Header-Name*". |
|
||||
| `value` | Set to specify the value of the custom header with `value` = "*Custom Header Value*". |
|
||||
|
||||
### user_workload_defaults (optional)
|
||||
|
||||
`user_workload_defaults.swarm_defaults`
|
||||
|
||||
A map describing default values to set on Swarm services at creation time if
|
||||
those fields are not explicitly set in the service spec.
|
||||
|
||||
| Parameter | Required | Description |
|
||||
|:-----------------------------------------|:---------|:---------------------------------------------------------------------|
|
||||
| `tasktemplate.restartpolicy.delay` | no | Delay between restart attempts (ns|us|ms|s|m|h).The default is `5s`. |
|
||||
| `tasktemplate.restartpolicy.maxattempts` | no | Maximum number of restarts before giving up. The default is `3`. |
|
||||
|
||||
### cluster_config table (required)
|
||||
|
||||
Configures the cluster that the current UCP instance manages.
|
||||
|
|
@ -198,7 +210,7 @@ components. Assigning these values overrides the settings in a container's
|
|||
| `calico_mtu` | no | Set the MTU (maximum transmission unit) size for the Calico plugin. |
|
||||
| `ipip_mtu` | no | Set the IPIP MTU size for the calico IPIP tunnel interface. |
|
||||
| `azure_ip_count` | no | Set the IP count for azure allocator to allocate IPs per Azure virtual machine. |
|
||||
| `service-cluster-ip-range` | yes | Sets the subnet pool from which the IP for Services should be allocated. Default is `10.96.0.0/16`.
|
||||
| `service_cluster_ip_range` | yes | Sets the subnet pool from which the IP for Services should be allocated. Default is `10.96.0.0/16`. |
|
||||
| `nodeport_range` | yes | Set the port range that for Kubernetes services of type NodePort can be exposed in. Default is `32768-35535`. |
|
||||
| `custom_kube_api_server_flags` | no | Set the configuration options for the Kubernetes API server. (dev) |
|
||||
| `custom_kube_controller_manager_flags` | no | Set the configuration options for the Kubernetes controller manager. (dev) |
|
||||
|
|
@ -207,6 +219,7 @@ components. Assigning these values overrides the settings in a container's
|
|||
| `local_volume_collection_mapping` | no | Store data about collections for volumes in UCP's local KV store instead of on the volume labels. This is used for enforcing access control on volumes. |
|
||||
| `manager_kube_reserved_resources` | no | Reserve resources for Docker UCP and Kubernetes components which are running on manager nodes. |
|
||||
| `worker_kube_reserved_resources` | no | Reserve resources for Docker UCP and Kubernetes components which are running on worker nodes. |
|
||||
| `kubelet_max_pods` | yes | Set Number of Pods that can run on a node. Default is `110`.
|
||||
|
||||
|
||||
*dev indicates that the functionality is only for development and testing. Arbitrary Kubernetes configuration parameters are not tested and supported under the Docker Enterprise Software Support Agreement.
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ If you are installing on Azure, see [Install UCP on Azure](/ee/ucp/admin/install
|
|||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|:-------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--debug, -D` | Enable debug mode |
|
||||
| `--jsonlog` | Produce json formatted output for easier parsing |
|
||||
| `--interactive, -i` | Run in interactive mode and prompt for configuration values |
|
||||
|
|
@ -78,10 +78,11 @@ If you are installing on Azure, see [Install UCP on Azure](/ee/ucp/admin/install
|
|||
| `--registry-password` *value* | Password to use when pulling images [$REGISTRY_PASSWORD] |
|
||||
| `--registry-username` *value* | Username to use when pulling images [$REGISTRY_USERNAME] |
|
||||
| `--san` *value* | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) [$UCP_HOSTNAMES] |
|
||||
| `--service-cluster-ip-range` *value* | Kubernetes Cluster IP Range for Services (Default: 10.96.0.0/16) (default: "10.96.0.0/16") |
|
||||
| `--skip-cloud-provider-check` | Disables checks which rely on detecting which (if any) cloud provider the cluster is currently running on |
|
||||
| `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility |
|
||||
| `--swarm-grpc-port` *value* | Port for communication between nodes (default: 2377) |
|
||||
| `--swarm-port` *value* | Port for the Docker Swarm manager. Used for backwards compatibility (default: 2376) |
|
||||
| `--unlock-key` *value* | The unlock key for this swarm-mode cluster, if one exists. [$UNLOCK_KEY] |
|
||||
| `--unmanaged-cni` | Flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider) | |
|
||||
| `--unmanaged-cni` | Flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider) |
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue