Skip to content

Commit eb61d54

Browse files
authored
Merge pull request #33410 from nate-double-u/merged-main-dev-1.24
Merged main into dev-1.24
2 parents 7f13ad0 + 5ead53b commit eb61d54

File tree

141 files changed

+5079
-660
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

141 files changed

+5079
-660
lines changed

README-ja.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
このリポジトリには、[KubernetesのWebサイトとドキュメント](https://kubernetes.io/)をビルドするために必要な全アセットが格納されています。貢献に興味を持っていただきありがとうございます!
66

7+
- [ドキュメントに貢献する](#contributing-to-the-docs)
8+
- [翻訳された`README.md`一覧](#localization-readmemds)
9+
710
# リポジトリの使い方
811

912
Hugo(Extended version)を使用してWebサイトをローカルで実行することも、コンテナランタイムで実行することもできます。コンテナランタイムを使用することを強くお勧めします。これにより、本番Webサイトとのデプロイメントの一貫性が得られます。
@@ -56,6 +59,43 @@ make serve
5659

5760
これで、Hugoのサーバーが1313番ポートを使って開始します。お使いのブラウザにて http://localhost:1313 にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
5861

62+
## API reference pagesをビルドする
63+
64+
`content/en/docs/reference/kubernetes-api`に配置されているAPIリファレンスページは<https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs>を使ってSwagger仕様書からビルドされています。
65+
66+
新しいKubernetesリリースのためにリファレンスページをアップデートするには、次の手順を実行します:
67+
68+
1. `api-ref-generator`サブモジュールをプルする:
69+
70+
```bash
71+
git submodule update --init --recursive --depth 1
72+
```
73+
74+
2. Swagger仕様書を更新する:
75+
76+
```bash
77+
curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
78+
```
79+
80+
3. 新しいリリースの変更を反映するため、`api-ref-assets/config/``toc.yaml``fields.yaml`を適用する。
81+
82+
4. 次に、ページをビルドする:
83+
84+
```bash
85+
make api-reference
86+
```
87+
88+
コンテナイメージからサイトを作成・サーブする事でローカルで結果をテストすることができます:
89+
90+
```bash
91+
make container-image
92+
make container-serve
93+
```
94+
95+
APIリファレンスを見るために、ブラウザで<http://localhost:1313/docs/reference/kubernetes-api/>を開いてください。
96+
97+
5. 新しいコントラクトのすべての変更が設定ファイル`toc.yaml``fields.yaml`に反映されたら、新しく生成されたAPIリファレンスページとともにPull Requestを作成します。
98+
5999
## トラブルシューティング
60100

61101
### error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version
@@ -107,7 +147,7 @@ sudo launchctl load -w /Library/LaunchDaemons/limit.maxfiles.plist
107147
- [Slack](https://kubernetes.slack.com/messages/kubernetes-docs-ja)
108148
- [メーリングリスト](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
109149

110-
## ドキュメントに貢献する
150+
## ドキュメントに貢献する {#contributing-to-the-docs}
111151

112152
GitHubの画面右上にある**Fork**ボタンをクリックすると、お使いのGitHubアカウントに紐付いた本リポジトリのコピーが作成され、このコピーのことを*フォーク*と呼びます。フォークリポジトリの中ではお好きなように変更を加えていただいて構いません。加えた変更をこのリポジトリに追加したい任意のタイミングにて、フォークリポジトリからPull Reqeustを作成してください。
113153

@@ -124,7 +164,15 @@ Kubernetesのドキュメントへの貢献に関する詳細については以
124164
* [ドキュメントのスタイルガイド](https://kubernetes.io/docs/contribute/style/style-guide/)
125165
* [Kubernetesドキュメントの翻訳方法](https://kubernetes.io/docs/contribute/localization/)
126166

127-
## 翻訳された`README.md`一覧
167+
### New Contributor Ambassadors
168+
169+
コントリビュートする時に何か助けが必要なら、[New Contributor Ambassadors](https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador)に聞いてみると良いでしょう。彼らはSIG Docsのapproverで、最初の数回のPull Requestを通して新しいコントリビューターを指導し助けることを責務としています。New Contributors Ambassadorsにコンタクトするには、[Kubernetes Slack](https://slack.k8s.io)が最適な場所です。現在のSIG DocsのNew Contributor Ambassadorは次の通りです:
170+
171+
| 名前 | Slack | GitHub |
172+
| -------------------------- | -------------------------- | -------------------------- |
173+
| Arsh Sharma | @arsh | @RinkiyaKeDad |
174+
175+
## 翻訳された`README.md`一覧 {#localization-readmemds}
128176

129177
| Language | Language |
130178
|---|---|

content/en/blog/_posts/2017-06-00-Kubernetes-1-7-Security-Hardening-Stateful-Application-Extensibility-Updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Security:
1919
- [Node authorizer](/docs/reference/access-authn-authz/node/) and admission control plugin are new additions that restrict kubelet’s access to secrets, pods and other objects based on its node.
2020
- [Encryption for Secrets](/docs/tasks/administer-cluster/encrypt-data/), and other resources in etcd, is now available as alpha.&nbsp;
2121
- [Kubelet TLS bootstrapping](/docs/admin/kubelet-tls-bootstrapping/) now supports client and server certificate rotation.
22-
- [Audit logs](/docs/tasks/debug-application-cluster/audit/) stored by the API server are now more customizable and extensible with support for event filtering and webhooks. They also provide richer data for system audit.
22+
- [Audit logs](/docs/tasks/debug/debug-cluster/audit/) stored by the API server are now more customizable and extensible with support for event filtering and webhooks. They also provide richer data for system audit.
2323

2424
Stateful workloads:
2525

content/en/blog/_posts/2017-12-00-Using-Ebpf-In-Kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ To achieve the best possible isolation, each function call would have to happen
117117
By using Landlock, we could isolate function calls from each other within the same container, making a temporary file created by one function call inaccessible to the next function call, for example. Integration between Landlock and technologies like Kubernetes-based serverless frameworks would be a ripe area for further exploration.
118118

119119
## Auditing kubectl-exec with eBPF
120-
In Kubernetes 1.7 the [audit proposal](/docs/tasks/debug-application-cluster/audit/) started making its way in. It's currently pre-stable with plans to be stable in the 1.10 release. As the name implies, it allows administrators to log and audit events that take place in a Kubernetes cluster.
120+
In Kubernetes 1.7 the [audit proposal](/docs/tasks/debug/debug-cluster/audit/) started making its way in. It's currently pre-stable with plans to be stable in the 1.10 release. As the name implies, it allows administrators to log and audit events that take place in a Kubernetes cluster.
121121

122122
While these events log Kubernetes events, they don't currently provide the level of visibility that some may require. For example, while we can see that someone has used `kubectl exec` to enter a container, we are not able to see what commands were executed in that session. With eBPF one can attach a BPF program that would record any commands executed in the `kubectl exec` session and pass those commands to a user-space program that logs those events. We could then play that session back and know the exact sequence of events that took place.
123123
## Learn more about eBPF

content/en/blog/_posts/2018-07-18-11-ways-not-to-get-hacked.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ There are plenty of [good examples](https://docs.bitnami.com/kubernetes/how-to/c
6666

6767
Incorrect or excessively permissive RBAC policies are a security threat in case of a compromised pod. Maintaining least privilege, and continuously reviewing and improving RBAC rules, should be considered part of the "technical debt hygiene" that teams build into their development lifecycle.
6868

69-
[Audit Logging](/docs/tasks/debug-application-cluster/audit/) (beta in 1.10) provides customisable API logging at the payload (e.g. request and response), and also metadata levels. Log levels can be tuned to your organisation&#39;s security policy - [GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/audit-logging#audit_policy) provides sane defaults to get you started.
69+
[Audit Logging](/docs/tasks/debug/debug-cluster/audit/) (beta in 1.10) provides customisable API logging at the payload (e.g. request and response), and also metadata levels. Log levels can be tuned to your organisation&#39;s security policy - [GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/audit-logging#audit_policy) provides sane defaults to get you started.
7070

7171
For read requests such as get, list, and watch, only the request object is saved in the audit logs; the response object is not. For requests involving sensitive data such as Secret and ConfigMap, only the metadata is exported. For all other requests, both request and response objects are saved in audit logs.
7272

content/en/blog/_posts/2018-08-03-make-kubernetes-production-grade-anywhere.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Cluster-distributed stateful services (e.g., Cassandra) can benefit from splitti
174174

175175
## Other considerations
176176

177-
[Logs](/docs/concepts/cluster-administration/logging/) and [metrics](/docs/tasks/debug-application-cluster/resource-usage-monitoring/) (if collected and persistently retained) are valuable to diagnose outages, but given the variety of technologies available it will not be addressed in this blog. If Internet connectivity is available, it may be desirable to retain logs and metrics externally at a central location.
177+
[Logs](/docs/concepts/cluster-administration/logging/) and [metrics](/docs/tasks/debug/debug-cluster/resource-usage-monitoring/) (if collected and persistently retained) are valuable to diagnose outages, but given the variety of technologies available it will not be addressed in this blog. If Internet connectivity is available, it may be desirable to retain logs and metrics externally at a central location.
178178

179179
Your production deployment should utilize an automated installation, configuration and update tool (e.g., [Ansible](https://github.com/kubernetes-incubator/kubespray), [BOSH](https://github.com/cloudfoundry-incubator/kubo-deployment), [Chef](https://github.com/chef-cookbooks/kubernetes), [Juju](/docs/getting-started-guides/ubuntu/installation/), [kubeadm](/docs/reference/setup-tools/kubeadm/), [Puppet](https://forge.puppet.com/puppetlabs/kubernetes), etc.). A manual process will have repeatability issues, be labor intensive, error prone, and difficult to scale. [Certified distributions](https://www.cncf.io/certification/software-conformance/#logos) are likely to include a facility for retaining configuration settings across updates, but if you implement your own install and config toolchain, then retention, backup and recovery of the configuration artifacts is essential. Consider keeping your deployment components and settings under a version control system such as Git.
180180

content/en/blog/_posts/2020-09-03-warnings/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ group_right() apiserver_request_total
177177

178178
Metrics are a fast way to check whether deprecated APIs are being used, and at what rate,
179179
but they don't include enough information to identify particular clients or API objects.
180-
Starting in Kubernetes v1.19, [audit events](/docs/tasks/debug-application-cluster/audit/)
180+
Starting in Kubernetes v1.19, [audit events](/docs/tasks/debug/debug-cluster/audit/)
181181
for requests to deprecated APIs include an audit annotation of `"k8s.io/deprecated":"true"`.
182182
Administrators can use those audit events to identify specific clients or objects that need to be updated.
183183

content/en/blog/_posts/2020-11-18-cloud-native-security-for-your-cluster/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The paper attempts to _not_ focus on any specific [cloud native project](https:/
2020
When using Kubernetes as a workload orchestrator, some of the security controls this version of the whitepaper recommends are:
2121
* [Pod Security Policies](/docs/concepts/security/pod-security-policy/): Implement a single source of truth for “least privilege” workloads across the entire cluster
2222
* [Resource requests and limits](/docs/concepts/configuration/manage-resources-containers/#requests-and-limits): Apply requests (soft constraint) and limits (hard constraint) for shared resources such as memory and CPU
23-
* [Audit log analysis](/docs/tasks/debug-application-cluster/audit/): Enable Kubernetes API auditing and filtering for security relevant events
23+
* [Audit log analysis](/docs/tasks/debug/debug-cluster/audit/): Enable Kubernetes API auditing and filtering for security relevant events
2424
* [Control plane authentication and certificate root of trust](/docs/concepts/architecture/control-plane-node-communication/): Enable mutual TLS authentication with a trusted CA for communication within the cluster
2525
* [Secrets management](/docs/concepts/configuration/secret/): Integrate with a built-in or external secrets store
2626

content/en/blog/_posts/2020-12-02-dockershim-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ runtime where possible.
155155

156156
Another thing to look out for is anything expecting to run for system maintenance
157157
or nested inside a container when building images will no longer work. For the
158-
former, you can use the [`crictl`][cr] tool as a drop-in replacement (see [mapping from docker cli to crictl](https://kubernetes.io/docs/tasks/debug-application-cluster/crictl/#mapping-from-docker-cli-to-crictl)) and for the
158+
former, you can use the [`crictl`][cr] tool as a drop-in replacement (see [mapping from docker cli to crictl](https://kubernetes.io/docs/tasks/debug/debug-cluster/crictl/#mapping-from-docker-cli-to-crictl)) and for the
159159
latter you can use newer container build options like [img], [buildah],
160160
[kaniko], or [buildkit-cli-for-kubectl] that don’t require Docker.
161161

content/en/blog/_posts/2020-12-08-kubernetes-release-1.20.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The `kubectl alpha debug` features graduates to beta in 1.20, becoming `kubectl
3232

3333
Note that as a new built-in command, `kubectl debug` takes priority over any kubectl plugin named “debug”. You must rename the affected plugin.
3434

35-
Invocations using `kubectl alpha debug` are now deprecated and will be removed in a subsequent release. Update your scripts to use `kubectl debug`. For more information about `kubectl debug`, see [Debugging Running Pods](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-running-pod/).
35+
Invocations using `kubectl alpha debug` are now deprecated and will be removed in a subsequent release. Update your scripts to use `kubectl debug`. For more information about `kubectl debug`, see [Debugging Running Pods](https://kubernetes.io/docs/tasks/debug/debug-application/debug-running-pod/).
3636

3737
### Beta: API Priority and Fairness
3838

content/en/blog/_posts/2021-10-05-nsa-cisa-hardening.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ RequestResponse's including metadata and request / response bodies. While helpfu
317317

318318
Each organization needs to evaluate their
319319
own threat model and build an audit policy that complements or helps troubleshooting incident response. Think
320-
about how someone would attack your organization and what audit trail could identify it. Review more advanced options for tuning audit logs in the official [audit logging documentation](/docs/tasks/debug-application-cluster/audit/#audit-policy).
320+
about how someone would attack your organization and what audit trail could identify it. Review more advanced options for tuning audit logs in the official [audit logging documentation](/docs/tasks/debug/debug-cluster/audit/#audit-policy).
321321
It's crucial to tune your audit logs to only include events that meet your threat model. A minimal audit policy that logs everything at `metadata` level can also be a good starting point.
322322

323323
Audit logging configurations can also be tested with

0 commit comments

Comments
 (0)