Skip to content

Commit

Permalink
Incremental update from master (#10278)
Browse files Browse the repository at this point in the history
* fix invalid href of cloud controller manager (#10240)

* fix invalid yaml format (#10238)

* update storage-limits doc with Azure disk part (#10224)

update storage-limits doc with Azure disk part

fix comments

* Update kubelet-config-file.md (#10222)

Update link to KubeletConfiguration struct.

* fix a trivial misspelling (#10244)

* Fix cassandra-statefulset.yaml indent level (#10243)

* Mention minimum etcd versions (#10208)

Source: https://groups.google.com/d/msg/kubernetes-dev/jMPA4JzKiY4/HIx2ugvLBAAJ

* fix 404 error (#10250)

* Small verb tweak (#10190)

Present participle, ftw.

* Add AnchorJS logic for header links (#10155)

* Add AnchorJS JavaScript

* Remove existing inpage_heading logic

* Remove underline from anchor tags

* Use single icon and add touch visibility

* Use paragraph link icon for AnchorJS

* Update Sass to use code formatting in docsContent headers

* Update header size coverage to H3-H6

* fix broken link in kubefed.md (#10254)

* Update the version numbers for the X-Remote-Extra- and Impersonate-Extra- key fixes (#9827)

The fix was cherry picked into 1.11.3, 1.10.7, and 1.9.11:

kubernetes/kubernetes#67162
kubernetes/kubernetes#67163
kubernetes/kubernetes#67164

* fix typo (#10168)

* fix typo

* addressing comments.

* Update setup-ha-etcd-with-kubeadm.md

* fix typos (#10252)

* fix description of contribute guide (#10253)

* describe truncate feature about advanced audit (#10236)

* describe truncate feature about advanced audit

* Update audit.md
  • Loading branch information
zparnold authored and k8s-ci-robot committed Sep 12, 2018
1 parent 19d8375 commit 90f7df6
Show file tree
Hide file tree
Showing 33 changed files with 81 additions and 2,023 deletions.
7 changes: 0 additions & 7 deletions assets/sass/_base.sass
Original file line number Diff line number Diff line change
Expand Up @@ -800,8 +800,6 @@ dd
&:after
transform: rotate(-45deg)



#docsContent
position: relative
float: right
Expand Down Expand Up @@ -895,7 +893,6 @@ dd
overflow-x: auto

h1 code, h2 code, h3 code, h4 code, h5 code, h6 code
font-family: inherit
font-size: inherit
background-color: transparent

Expand Down Expand Up @@ -999,10 +996,6 @@ dd
img
max-width: 100%

a
//font-weight: 700
text-decoration: underline

#TableOfContents > ul > li { list-style: none; }
#TableOfContents
ul, li
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ CONTAINER ID IMAGE COMMAND CREATED STATUS
docker\_cr.sh
```

Since the command line arguments to CRIU were long, a helper script called docker\_cr.sh was provided in the CRIU source tree to simplify the proces. So, for the above container, one would simply C/R the container as follows (for details see [http://criu.org/Docker](http://criu.org/Docker)):
Since the command line arguments to CRIU were long, a helper script called docker\_cr.sh was provided in the CRIU source tree to simplify the process. So, for the above container, one would simply C/R the container as follows (for details see [http://criu.org/Docker](http://criu.org/Docker)):

```
$ sudo docker\_cr.sh -c 4397
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/concepts/overview/what-is-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Summary of container benefits:
Runs on Ubuntu, RHEL, CoreOS, on-prem, Google Kubernetes Engine, and anywhere else.
* **Application-centric management**:
Raises the level of abstraction from running an OS on virtual
hardware to run an application on an OS using logical resources.
hardware to running an application on an OS using logical resources.
* **Loosely coupled, distributed, elastic, liberated [micro-services](https://martinfowler.com/articles/microservices.html)**:
Applications are broken into smaller, independent pieces and can
be deployed and managed dynamically -- not a fat monolithic stack
Expand Down
3 changes: 3 additions & 0 deletions content/en/docs/concepts/storage/storage-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ is an alpha feature that supports these services:

- Amazon EBS
- Google Persistent Disk
- Azure Disk

To enable dynamic volume limits, set the `AttachVolumeLimit`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
Expand All @@ -73,4 +74,6 @@ volumes to be attached to a node. For other instance types on
<a href="https://aws.amazon.com/ec2/">Amazon Elastic Compute Cloud (EC2)</a>,
Kubernetes allows 39 volumes to be attached to a node.

* On Azure, up to 64 disks can be attached to a node, depending on the node type. For more details, refer to [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes).

{{% /capture %}}
2 changes: 1 addition & 1 deletion content/en/docs/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Looking for the [style guide](/docs/contribute/style/style-guide/)?

## Types of contributor

- A _member_ of the Kubernetes organization has [signed the CLA](/contribute/start#sign-the-cla)
- A _member_ of the Kubernetes organization has [signed the CLA](/docs/contribute/start#sign-the-cla)
and contributed some time and effort to the project. See
[Community membership](https://github.com/kubernetes/community/blob/master/community-membership.md)
for specific criteria for membership.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ It is designed for use in combination with an authenticating proxy, which sets t
* `--requestheader-group-headers` 1.6+. Optional, case-insensitive. "X-Remote-Group" is suggested. Header names to check, in order, for the user's groups. All values in all specified headers are used as group names.
* `--requestheader-extra-headers-prefix` 1.6+. Optional, case-insensitive. "X-Remote-Extra-" is suggested. Header prefixes to look for to determine extra information about the user (typically used by the configured authorization plugin). Any headers beginning with any of the specified prefixes have the prefix removed. The remainder of the header name is lowercased and [percent-decoded](https://tools.ietf.org/html/rfc3986#section-2.1) and becomes the extra key, and the header value is the extra value.
{{< note >}}
**Note:** Prior to 1.11.2, the extra key could only contain characters which were [legal in HTTP header labels](https://tools.ietf.org/html/rfc7230#section-3.2.6).
**Note:** Prior to 1.11.3 (and 1.10.7, 1.9.11), the extra key could only contain characters which were [legal in HTTP header labels](https://tools.ietf.org/html/rfc7230#section-3.2.6).
{{< /note >}}

For example, with this configuration:
Expand Down Expand Up @@ -597,7 +597,7 @@ The following HTTP headers can be used to performing an impersonation request:
* `Impersonate-Extra-( extra name )`: A dynamic header used to associate extra fields with the user. Optional. Requires "Impersonate-User". In order to be preserved consistently, `( extra name )` should be lower-case, and any characters which aren't [legal in HTTP header labels](https://tools.ietf.org/html/rfc7230#section-3.2.6) MUST be utf8 and [percent-encoded](https://tools.ietf.org/html/rfc3986#section-2.1).

{{< note >}}
**Note:** Prior to 1.11.2, `( extra name )` could only contain characters which were [legal in HTTP header labels](https://tools.ietf.org/html/rfc7230#section-3.2.6).
**Note:** Prior to 1.11.3 (and 1.10.7, 1.9.11), `( extra name )` could only contain characters which were [legal in HTTP header labels](https://tools.ietf.org/html/rfc7230#section-3.2.6).
{{< /note >}}

An example set of headers:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
For more details, please see [Pod readiness gate](/docs/concepts/workloads/pods/pod-lifecycle/#pod-readiness-gate).
- `PVCProtection`: Enable the prevention of a PersistentVolumeClaim (PVC) from
being deleted when it is still used by any Pod.
More details can be found [here](/docs/tasks/administer-cluster/pvc-protection/).
More details can be found [here](/docs/tasks/administer-cluster/storage-object-in-use-protection/).
- `ReadOnlyAPIDataVolumes`: Set Secret, ConfigMap, DownwardAPI and projected volumes to be mounted in read-only mode.
This gate exists only for backward compatibility. It will be removed in 1.11 release.
- `ResourceLimitsPriorityFunction`: Enable a scheduler priority function that
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ kubelet [flags]
<td colspan="2">--enforce-node-allocatable stringSlice</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptible options are 'pods', 'system-reserved' & 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' & '--kube-reserved-cgroup' must also be set respectively. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details. (default [pods])</td>
<td></td><td style="line-height: 130%; word-wrap: break-word;">A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptable options are 'pods', 'system-reserved' & 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' & '--kube-reserved-cgroup' must also be set respectively. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details. (default [pods])</td>
</tr>

<tr>
Expand Down Expand Up @@ -510,7 +510,7 @@ kubelet [flags]
<td colspan="2">--experimental-check-node-capabilities-before-mount</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[Experimental] if set true, the kubelet will check the underlying node for required componenets (binaries, etc.) before performing the mount</td>
<td></td><td style="line-height: 130%; word-wrap: break-word;">[Experimental] if set true, the kubelet will check the underlying node for required components (binaries, etc.) before performing the mount</td>
</tr>

<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,6 @@ kubefed init FEDERATION_NAME --host-cluster-context=HOST_CONTEXT [flags]
```

### SEE ALSO
* [kubefed](kubefed.md) - kubefed controls a Kubernetes Cluster Federation
* [kubefed](/docs/reference/setup-tools/kubefed/kubefed/) - kubefed controls a Kubernetes Cluster Federation

###### Auto generated by spf13/cobra on 25-Mar-2018
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,6 @@ kubefed join CLUSTER_NAME --host-cluster-context=HOST_CONTEXT [flags]
```

### SEE ALSO
* [kubefed](kubefed.md) - kubefed controls a Kubernetes Cluster Federation
* [kubefed](/docs/reference/setup-tools/kubefed/kubefed/) - kubefed controls a Kubernetes Cluster Federation

###### Auto generated by spf13/cobra on 25-Mar-2018
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ kubefed options [flags]
```

### SEE ALSO
* [kubefed](kubefed.md) - kubefed controls a Kubernetes Cluster Federation
* [kubefed](/docs/reference/setup-tools/kubefed/kubefed/) - kubefed controls a Kubernetes Cluster Federation

###### Auto generated by spf13/cobra on 25-Mar-2018
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,6 @@ kubefed unjoin CLUSTER_NAME --host-cluster-context=HOST_CONTEXT [flags]
```

### SEE ALSO
* [kubefed](kubefed.md) - kubefed controls a Kubernetes Cluster Federation
* [kubefed](/docs/reference/setup-tools/kubefed/kubefed/) - kubefed controls a Kubernetes Cluster Federation

###### Auto generated by spf13/cobra on 25-Mar-2018
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ kubefed version [flags]
```

### SEE ALSO
* [kubefed](kubefed.md) - kubefed controls a Kubernetes Cluster Federation
* [kubefed](/docs/reference/setup-tools/kubefed/kubefed/) - kubefed controls a Kubernetes Cluster Federation

###### Auto generated by spf13/cobra on 25-Mar-2018
10 changes: 5 additions & 5 deletions content/en/docs/reference/setup-tools/kubefed/kubefed.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ kubefed [flags]
```

### SEE ALSO
* [kubefed init](kubefed_init.md) - Initialize a federation control plane
* [kubefed join](kubefed_join.md) - Join a cluster to a federation
* [kubefed options](kubefed_options.md) - Print the list of flags inherited by all commands
* [kubefed unjoin](kubefed_unjoin.md) - Unjoin a cluster from a federation
* [kubefed version](kubefed_version.md) - Print the client and server version information
* [kubefed init](/docs/reference/setup-tools/kubefed/kubefed-init/) - Initialize a federation control plane
* [kubefed join](/docs/reference/setup-tools/kubefed/kubefed-join/) - Join a cluster to a federation
* [kubefed options](/docs/reference/setup-tools/kubefed/kubefed-options/) - Print the list of flags inherited by all commands
* [kubefed unjoin](/docs/reference/setup-tools/kubefed/kubefed-unjoin/) - Unjoin a cluster from a federation
* [kubefed version](/docs/reference/setup-tools/kubefed/kubefed-version/) - Print the client and server version information

###### Auto generated by spf13/cobra on 25-Mar-2018
10 changes: 5 additions & 5 deletions content/en/docs/setup/independent/setup-ha-etcd-with-kubeadm.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
reviewers:
- sig-cluster-lifecycle
title: Set up a Highly Availabile etcd Cluster With kubeadm
title: Set up a High Availability etcd cluster with kubeadm
content_template: templates/task
weight: 60
---

{{% capture overview %}}

Kubeadm defaults to running a single member etcd cluster in a static pod managed
by the kubelet on the control plane node. This is not a highly available setup
by the kubelet on the control plane node. This is not a high availability setup
as the etcd cluster contains only one member and cannot sustain any members
becoming unavailable. This task walks through the process of creating a highly
available etcd cluster of three members that can be used as an external etcd
becoming unavailable. This task walks through the process of creating a high
availability etcd cluster of three members that can be used as an external etcd
when using kubeadm to set up a kubernetes cluster.

{{% /capture %}}
Expand Down Expand Up @@ -108,7 +108,7 @@ this example.
If you already have a CA then the only action that is copying the CA's `crt` and
`key` file to `/etc/kubernetes/pki/etcd/ca.crt` and
`/etc/kubernetes/pki/etcd/ca.key`. After those files have been copied, please
skip this step.
proceed to "Create certificates for each member".
If you do not already have a CA then run this command on `$HOST0` (where you
generated the configuration files for kubeadm).
Expand Down
11 changes: 3 additions & 8 deletions content/en/docs/setup/scratch.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,18 +194,13 @@ You have several choices for Kubernetes images:
- You can verify if the image is loaded successfully with the right repository and tag using
command like `docker images`

For etcd, you can:

- Use images hosted on Google Container Registry (GCR), such as `k8s.gcr.io/etcd:2.2.1`
- Use images hosted on [Docker Hub](https://hub.docker.com/search/?q=etcd) or [Quay.io](https://quay.io/repository/coreos/etcd), such as `quay.io/coreos/etcd:v2.2.1`
- Use etcd binary included in your OS distro.
- Build your own image
- You can do: `cd kubernetes/cluster/images/etcd; make`

We recommend that you use the etcd version which is provided in the Kubernetes binary distribution. The Kubernetes binaries in the release
were tested extensively with this version of etcd and not with any other version.
The recommended version number can also be found as the value of `TAG` in `kubernetes/cluster/images/etcd/Makefile`.

For the miniumum recommended version of etcd, please refer to
[Configuring and Updating etcd](/docs/tasks/administer-cluster/configure-upgrade-etcd/)

The remainder of the document assumes that the image identifiers have been chosen and stored in corresponding env vars. Examples (replace with latest tags and appropriate registry):

- `HYPERKUBE_IMAGE=k8s.gcr.io/hyperkube:$TAG`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ you **on a best-effort basis**.

For example, if your ThirdPartyResource looks like this:

```yaml
apiVersion: extensions/v1beta1
kind: ThirdPartyResource
metadata:
name: cron-tab.stable.example.com
description: "A specification of a Pod to run on a cron style schedule"
versions:
- name: v1
```

apiVersion: extensions/v1beta1
kind: ThirdPartyResource
metadata:
name: cron-tab.stable.example.com
description: "A specification of a Pod to run on a cron style schedule"
versions:
- name: v1


A matching CustomResourceDefinition could look like this:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ content_template: templates/task

* Keeping stable etcd clusters is critical to the stability of Kubernetes clusters. Therefore, run etcd clusters on dedicated machines or isolated environments for [guaranteed resource requirements](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/hardware.md#hardware-recommendations).

* The minimum recommended version of etcd to run in production is `3.2.10+`.

## Resource requirements

Operating etcd with limited resources is suitable only for testing purposes. For deploying in production, advanced hardware configuration is required. Before deploying etcd in production, see [resource requirement reference documentation](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/hardware.md#example-hardware-configurations).
Expand Down Expand Up @@ -388,6 +390,8 @@ TARGET_VERSION=2.2.1
STORAGE_MEDIA_TYPE=application/json
```

** Note: this upgrade procedure is for getting from 2.x to 3.x. Version `3.0.17` is not recommended for running in production (see [prerequisites](#prereqisites) for minimum recommended etcd versions.

## Notes for etcd Version 2.2.1

### Default configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ Using existing out-of-tree cloud providers as an example may be helpful. You can

### In Tree

For in-tree cloud providers, you can run the in-tree cloud controller manager as a [Daemonset](/docs/tasks/administer-cluster/cloud-controller-manager-daemonset-example.yaml) in your cluster. See the [running cloud controller manager docs](/docs/tasks/administer-cluster/running-cloud-controller.md) for more details.
For in-tree cloud providers, you can run the in-tree cloud controller manager as a [Daemonset](/examples/admin/cloud/ccm-example.yaml) in your cluster. See the [running cloud controller manager docs](/docs/tasks/administer-cluster/running-cloud-controller.md) for more details.

{{% /capture %}}
{{% /capture %}}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ it simplifies node deployment and configuration management.

The subset of the Kubelet's configuration that can be configured via a file
is defined by the `KubeletConfiguration` struct
[here (v1beta1)](https://github.com/kubernetes/kubernetes/blob/{{< param "docsbranch" >}}/pkg/kubelet/apis/kubeletconfig/v1beta1/types.go).
[here (v1beta1)](https://github.com/kubernetes/kubernetes/blob/{{< param "docsbranch" >}}/pkg/kubelet/apis/config/types.go).

The configuration file must be a JSON or YAML representation of the parameters
in this struct. Make sure the Kubelet has read permissions on the file.
Expand Down
11 changes: 11 additions & 0 deletions content/en/docs/tasks/debug-application-cluster/audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,17 @@ and in the logs to monitor the state of the auditing subsystem.
- `apiserver_audit_error_total` metric contains the total number of events dropped due to an error
during exporting.

### Truncate

Both log and webhook backends support batching. As an example, the following is the list of flags
available for the log backend:

- `audit-log-truncate-enabled` whether event and batch truncating is enabled.
- `audit-log-truncate-max-batch-size` maximum size in bytes of the batch sent to the underlying backend.
- `audit-log-truncate-max-event-size` maximum size in bytes of the audit event sent to the underlying backend.

By default truncate is disabled in both `webhook` and `log`, a cluster administrator should set `audit-log-truncate-enabled` or `audit-webhook-truncate-enabled` to enable the feature.

## Multi-cluster setup

If you're extending the Kubernetes API with the [aggregation layer][kube-aggregator], you can also
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ spec:
cpu: "500m"
memory: 1Gi
requests:
cpu: "500m"
memory: 1Gi
cpu: "500m"
memory: 1Gi
securityContext:
capabilities:
add:
Expand Down
19 changes: 1 addition & 18 deletions layouts/docs/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,5 @@
</div>
{{ partialCached "footer.html" . }}
{{ partialCached "footer-scripts.html" . }}
<script>
// This script turns in-page headers into clickable and shareable
(function addHeadingLinks(){
var article = document.getElementById('docsContent');
var headings = article.querySelectorAll('h1, h2, h3, h4, h5, h6');
headings.forEach(function(heading){
if(heading.id){
var a = document.createElement('a');
a.innerHTML = heading.innerHTML;
a.href = '#'+heading.id;
a.classList.add('inpage_heading');
heading.innerHTML = '';
heading.appendChild(a);
}
});
})();
</script>
</body>
</html>
</html>
1 change: 1 addition & 0 deletions layouts/partials/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<meta property="og:image" content="{{ index . 0 | replaceRE ".*src=\"(.+?)\".*" "$1" }}" />
{{ end }}
{{ end }}
<script src="{{ "js/anchor-4.1.1.min.js" | relURL }}"></script>
<script src="{{ "js/jquery-3.2.1.min.js" | relURL }}"></script>
<script src="{{ "js/jquery-ui-1.12.1.min.js" | relURL }}"></script>
<script src="{{ "js/bootstrap-3.3.7.min.js" | relURL }}"></script>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Target":"css/styles.min.55d1e72cc5418eace24df1a4450abe45a6ee9111f9814269bc6540e8c49d2399.css","MediaType":"text/css","Data":{"Integrity":"sha256-VdHnLMVBjqziTfGkRQq+RabukRH5gUJpvGVA6MSdI5k="}}
{"Target":"css/styles.min.ece7e7b8765fe37209670b4fdb98dc7c18c77ce66f423368a943e602cf2ab436.css","MediaType":"text/css","Data":{"Integrity":"sha256-7OfnuHZf43IJZwtP25jcfBjHfOZvQjNoqUPmAs8qtDY="}}
Loading

0 comments on commit 90f7df6

Please sign in to comment.