Skip to content

Commit

Permalink
Docs: Change host_alias to host_aliases (#869)
Browse files Browse the repository at this point in the history
* Bugfix: host_alias to host_aliases

Bugfix: host_alias to host_aliases

* Update pod and daemonset documentation to reflect host_aliases

Per #413 (comment)

Co-authored-by: Miguel David <[email protected]>
  • Loading branch information
aareet and minac authored Jun 15, 2020
1 parent e326053 commit 81d71da
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions website/docs/r/daemonset.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ For more info see [Kubernetes reference](http://kubernetes.io/docs/user-guide/an
* `init_container` - (Optional) List of init containers belonging to the pod. Init containers always run to completion and each must complete successfully before the next is started. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/workloads/pods/init-containers)/
* `dns_policy` - (Optional) Set DNS policy for containers within the pod. Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. Optional: Defaults to 'ClusterFirst', see [Kubernetes reference](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy).
* `dns_config` - (Optional) Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. Defaults to empty. See `dns_config` block definition below.
* `host_alias` - (Optional) List of hosts and IPs that will be injected into the pod's hosts file if specified. Optional: Defaults to empty. See `host_alias` block definition below.
* `host_aliases` - (Optional) List of hosts and IPs that will be injected into the pod's hosts file if specified. Optional: Defaults to empty. See `host_aliases` block definition below.
* `host_ipc` - (Optional) Use the host's ipc namespace. Optional: Defaults to false.
* `host_network` - (Optional) Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified.
* `host_pid` - (Optional) Use the host's pid namespace.
Expand Down Expand Up @@ -467,11 +467,11 @@ The `option` block supports the following:
* `path` - (Required) The Glusterfs volume path. For more info see http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
* `read_only` - (Optional) Whether to force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. For more info see http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

### `host_alias`
### `host_aliases`

#### Arguments

* `hostnames` - (Required) Hostnames for the IP address.
* `hostnames` - (Required) Array of hostnames for the IP address.
* `ip` - (Required) IP address of the host file entry.

### `host_path`
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/deployment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ The `option` block supports the following:

#### Arguments

* `hostnames` - (Required) Hostnames for the IP address.
* `hostnames` - (Required) Array of hostnames for the IP address.
* `ip` - (Required) IP address of the host file entry.

### `host_path`
Expand Down
6 changes: 3 additions & 3 deletions website/docs/r/pod.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ For more info see [Kubernetes reference](http://kubernetes.io/docs/user-guide/la
* `init_container` - (Optional) List of init containers belonging to the pod. Init containers always run to completion and each must complete successfully before the next is started. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/workloads/pods/init-containers)/
* `dns_policy` - (Optional) Set DNS policy for containers within the pod. Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. Optional: Defaults to 'ClusterFirst', see [Kubernetes reference](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy).
* `dns_config` - (Optional) Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. Defaults to empty. See `dns_config` block definition below.
* `host_alias` - (Optional) List of hosts and IPs that will be injected into the pod's hosts file if specified. Optional: Defaults to empty. See `host_alias` block definition below.
* `host_aliases` - (Optional) List of hosts and IPs that will be injected into the pod's hosts file if specified. Optional: Defaults to empty. See `host_aliases` block definition below.
* `host_ipc` - (Optional) Use the host's ipc namespace. Optional: Defaults to false.
* `host_network` - (Optional) Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified.
* `host_pid` - (Optional) Use the host's pid namespace.
Expand Down Expand Up @@ -525,11 +525,11 @@ The `option` block supports the following:
* `path` - (Required) The Glusterfs volume path. For more info see http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
* `read_only` - (Optional) Whether to force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. For more info see http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

### `host_alias`
### `host_aliases`

#### Arguments

* `hostnames` - (Required) Hostnames for the IP address.
* `hostnames` - (Required) Array of hostnames for the IP address.
* `ip` - (Required) IP address of the host file entry.

### `host_path`
Expand Down

0 comments on commit 81d71da

Please sign in to comment.