Commit Graph

165 Commits

Author SHA1 Message Date
Kubernetes Prow Robot 0faa93ceca
Merge pull request #40027 from Jefftree/openapiv3-ga-doc
Doc update for KEP-2896 OpenAPIV3
2023-04-01 04:51:49 -07:00
Jefftree 0c9ba63075 Address comments 2023-03-31 18:17:30 +00:00
Kermit Alexander II e239a7dd33
Documentation for messageExpression update to KEP-2876 (#40019)
* Add messageExpression documentation.

* Apply feedback on wording.

* Add info about casting to string.

* Use "evaluates to an error" to avoid ambiguous wording around "fails."

* Revise wording around string casting.
2023-03-30 20:41:48 -07:00
Jefftree eb417b7128 Whitespace fix 2023-03-27 17:00:46 +00:00
Jefftree af3e11936b Update OpenAPI V3 section for CRDs 2023-03-27 17:00:46 +00:00
Oliver L Schoenborn 07ec542ee9
typo in notes section
Co-authored-by: Qiming Teng <tengqm@outlook.com>
2023-03-13 22:27:38 -04:00
Oliver L Schoenborn 5dc0185920 Simplify by focussing on kubectl ie no curl left except one mention; moved notes to the end where nuances are discussed such as upper/lower case env var, use of proxy-url, meaning of localhost vs socks5h, etc 2023-03-13 22:12:32 -04:00
Abigail McCarthy c4b70832dd Include index files 2023-01-17 09:14:01 -05:00
Michael 0cfca02a33 Fix link and bullets alignment in custom-resource-definition-versioning.md 2022-12-22 08:58:19 +08:00
Marcin Owsiany 270c6803d1 Applied review comment. 2022-12-14 12:15:28 +01:00
Marcin Owsiany 74dd655286 Clarify the case of requested version != stored version. 2022-12-14 12:12:28 +01:00
Marcin Owsiany 8c9ca0579d Use "stored" rather than "persisted" consistently with the rest of the document. 2022-12-14 12:12:28 +01:00
Kubernetes Prow Robot d3e08805fd
Merge pull request #37271 from maxgio92/patch-2
docs(setup-konnectivity.md): remove duplicate openssl option
2022-11-03 16:42:14 -07:00
mboukhalfa 0e569cc9ed
Update links in crd docs based to v1.25 k8s release 2022-10-25 14:13:02 +03:00
Kubernetes Prow Robot e368a6ae3f
Merge pull request #37381 from Nordix/tiny-spell-fix/mohammed
Tiny spell fix and rephrasing
2022-10-24 10:58:25 -07:00
mboukhalfa 388a17b204
tiny spell fix and rephrasing 2022-10-19 15:25:12 +03:00
Chandan Singh 8b1209d948
Update custom-resource-definition-versioning.md
Since there can be only one version that needs to be stored and storage option is required else the parsing fails. Adding the storage option and setting it false.

Schema Vaildation fails with error: error validating data: ValidationError(CustomResourceDefinition.spec.versions[1]): missing
 required field "storage" in io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion; if you choose to
 ignore these errors, turn validation off with --validate=false
2022-10-12 18:13:03 +05:30
maxgio92 1e2fd3cad8
docs(setup-konnectivity.md): remove duplicate openssl option
This cleans up the command to generate the certificate signin request for the Konnectivity server, by removing a duplicated openssl CLI option for the output file.

Signed-off-by: Massimiliano Giovagnoli me@maxgio.it
2022-10-11 16:37:51 +02:00
Kubernetes Prow Robot 15bf5813c6
Merge pull request #36716 from akankshakumari393/patch-6
Fix Broken Link to CustomResourceDefinition
2022-09-18 06:22:28 -07:00
Akanksha Kumari 0443319bda Update the CRD link to reference/kubernetes-api/extend-resources/custom-resource-definition-v1/ 2022-09-15 09:24:42 +05:30
Shubham 88380ad730
Modify note content about kubectl, CRDs, and subresources (#34468)
* Modified the NOTE for Kubectl Subresource Support.

Improvement: Removed word tool.

Typo fix.

* Added task for patch the deployment using subresource flag.

* Updated the content.

* Updated the link for kubectl patch.

* Resolved nits.

* Improvement: updated the content.

* Removed new deployment and used existing deployment manifests.
2022-09-14 15:41:23 -07:00
Akanksha Kumari d0e4c5942e Minor Typo Fix 2022-09-10 11:57:26 +05:30
Akanksha kumari 395143df47 Fix Broken Link to CustomResourceDefinition 2022-09-10 01:00:26 +05:30
Qiming Teng ef511e7e65 Style tweak the crd task file
This PR reformats the CRD task file where line wrappings are expected or
proper indentations are needed. It also fixes a link to the kube-apiserver
reference.
2022-08-25 16:04:02 +08:00
kadtendulkar 655f6a2b8b Update content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md 2022-08-24 21:45:12 +05:30
carolina valencia 6810fa976d Merge remote-tracking branch 'upstream/main' into dev-1.25 2022-08-18 15:58:41 -03:00
Cici Huang d6201fdf65 Update doc for CustomResourceValidationExpressions feature. 2022-08-16 15:38:37 +00:00
William Steinford d6a1ba2a6d Fix the grammar by using the verb form 'set up' where appropriate instead of the noun 'setup' 2022-08-08 16:48:26 -04:00
Michael 6a1caa355a [en] fix typos in /projected-volumes.md 2022-07-15 17:10:48 +08:00
Kubernetes Prow Robot 84c035d5a7
Merge pull request #34372 from tengqm/fix-links-1
Batch fixes for links (1)
2022-06-26 01:02:58 -07:00
Kubernetes Prow Robot 484995c06b
Merge pull request #33930 from xing-yang/deprecate_crd
Add doc for CRD version removal
2022-06-24 00:39:21 -07:00
Kubernetes Prow Robot 62a5ad6213
Merge pull request #34386 from Rishit-dagli/Rishit-dagli-updatecreatingCRD
Update Create a Custom Resource Definition
2022-06-23 17:03:19 -07:00
Rishit Dagli aa60715e84 Update Create a Custom Resource Definition
Co-authored-by: Antonio Alonso Alarcon <antonio.al.al@gmail.com>
2022-06-18 11:48:00 +00:00
Qiming Teng 7add552174 Batch fixes for links (1)
There are dangling links or links that redirects to a different destination page.
This PR fixes some of them.
2022-06-18 13:37:13 +08:00
Fabrice Jammes 1f22d45a3b
Update content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md
Co-authored-by: ZSC <zacharysarah@users.noreply.github.com>
2022-06-14 22:56:04 +02:00
Fabrice Jammes aba1766a83
Update content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md
Co-authored-by: ZSC <zacharysarah@users.noreply.github.com>
2022-06-14 22:55:22 +02:00
Fabrice Jammes 50cfc51fc9
Merge branch 'kubernetes:main' into patch-1 2022-06-14 17:22:08 +02:00
Kubernetes Prow Robot 29a21da70f
Merge pull request #33659 from macno/patch-1
Update Validation Rules Examples
2022-06-13 22:59:33 -07:00
lostick cfb897169b Fix typos in tasks docs 2022-05-31 14:47:40 +01:00
xing-yang 7cdbb1f3c4 Address comments 2022-05-25 19:24:47 +00:00
xing-yang 85f076192e Add doc for CRD version removal 2022-05-25 01:30:17 +00:00
Fabrice Jammes 34140f1087
Update socks5-proxy-access-api.md
If using `localhost` instead of <API_SERVER_IP_ADRESS>, you get a certificate error:
```
kubectl get pods
I0520 16:29:08.178277   41261 versioner.go:58] Get https://localhost:6443/version?timeout=5s: dial tcp 127.0.0.1:6443: connect: connection refused
Unable to connect to the server: x509: certificate is valid for ccqserv225, kubernetes, kubernetes.default, kubernetes.default.svc, kubernetes.default.svc.cluster.local, not localhost
```

Please also note that I have a warning message if I unset the `https_proxy` env variable:
```
 ⚙ kubectl get pods 
I0520 16:35:27.955076   43865 versioner.go:56] Remote kubernetes server unreachable
NAME                     READY   STATUS    RESTARTS   AGE
hub-54c6457f66-vlq2l     1/1     Running   0          4h27m
proxy-7b5b8dfb9d-dxrkz   1/1     Running   0          4h27m
# Whereas with the https_proxy variable:
 ⚙ export https_proxy=socks5://localhost:1080     
 ⚙ kubectl get pods                          
NAME                     READY   STATUS    RESTARTS   AGE
hub-54c6457f66-vlq2l     1/1     Running   0          4h28m
proxy-7b5b8dfb9d-dxrkz   1/1     Running   0          4h28m
```
Any idea is welcome here.
2022-05-20 16:38:22 +02:00
Michele Azzolari 9d08cafd2b
Update Validation Rules Example
Fix example add missing `=`
Add one more example
2022-05-14 10:45:09 +02:00
Rey Lejano 0bdd4d2d03 follow-up to pr 31527 to address comments 2022-05-03 18:46:39 -07:00
Romain Aviolat 7f13ad092c
Document using SOCKS5 to access Kubernetes API (#31527)
* ofeat: add SOCKS5 proxy documentation

Goal of this commit is to document the usage of SOCKS5 proxies to reach
the Kubernetes API.

* Apply suggestions from code review

Co-authored-by: chrismetz09 <cymetz@gmail.com>

* Apply suggestions from code review

Co-authored-by: Qiming Teng <tengqm@outlook.com>

* fix: apply contributors suggestions

* fix: apply contributors suggestions

* Update content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

* fix: apply new contributors suggestions

* Update content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

* feat: add cleanup and furter reading sections

* fix: comment on SOCKS5 proxy

* nit

* fix: workflow

Co-authored-by: chrismetz09 <cymetz@gmail.com>
Co-authored-by: Qiming Teng <tengqm@outlook.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-05-02 08:15:14 -07:00
cici37 40157c8e05 Address comments 2022-04-12 13:39:58 -07:00
Kermit Alexander e638ab5ee8 Reword resource constraint section. 2022-04-06 13:54:04 -07:00
cici37 46d35e2bab Adding doc for transition rules, func library and resource constraints. 2022-04-06 13:54:02 -07:00
Tim Bannister 73cd38cdc6 Move kubectl overview to be section index
Also:
- use glossary definition in page introduction
- tidy broken link in What's Next section
- update links to refer to moved page
2022-03-03 10:03:00 +00:00
cici37 002985c690 Reduce confusion by fixing field name in samples. 2022-03-01 13:01:47 -08:00
Qiming Teng b198199336 Configuration API for v1.23 2021-12-08 16:19:23 +08:00
Jesse Butler 584421fe11 Merge remote-tracking branch 'upstream/main' into dev-1.23 2021-12-06 08:55:54 -05:00
Kubernetes Prow Robot 4187c652f8
Merge pull request #29152 from tiraboschi/crd_edit_status
Concretely explain how to patch CRD status
2021-12-05 19:24:32 -08:00
Jesse Butler 018f9d05a2 Merge remote-tracking branch 'upstream/main' into dev-1.23 2021-12-01 12:23:10 -05:00
Ashish jaiswar b546825c32
Update content/en/docs/tasks/extend-kubernetes/setup-konnectivity.md
Co-authored-by: Meha Bhalodiya <mehabhalodiya@gmail.com>
2021-11-30 13:22:22 +05:30
cici37 cd1726aa10 Adding details on CEL validation for CRD. 2021-11-29 09:06:40 -08:00
Joe Betz a9641b6ccd Add stub for validatiton rule documentation 2021-11-29 09:06:40 -08:00
ashish-jaiswar edc96615a6 updated setup-konnectivity.md 2021-11-29 10:11:47 +05:30
Andrei Kvapil 69c6dc0a82
Refer ServiceAccountTokenVolumeProjection documentation instead of providing incorrect instructions.
Since Kubernetes v1.20 it is enabled by default.
2021-11-08 15:16:05 +01:00
chirangaalwis 7449bb36a0 Update config refs to KubeSchedulerConfiguration 2021-11-02 19:56:21 +05:30
Chiranga Alwis c5cb03ab13
Shorten the description on field updating
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2021-11-02 14:01:35 +05:30
Chiranga Alwis 7b6d84ec7c
Use note short code to highlight the content
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2021-11-02 13:59:24 +05:30
Chiranga Alwis 514db9eb70
Improve and reorder the wording
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2021-11-02 10:31:38 +05:30
Chiranga Alwis eedbfd5724
Add content best practices
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2021-11-02 10:28:51 +05:30
chirangaalwis 35525d17b5 Add extra details for clarity 2021-10-18 20:44:13 +05:30
Chiranga Alwis dcbf152118
Remove unnecessary reference to scheduler
Co-authored-by: Aldo Culquicondor <1299064+alculquicondor@users.noreply.github.com>
2021-10-18 20:29:53 +05:30
Chiranga Alwis 9a0f0e25ea
Rearrange words for better meaning
Co-authored-by: Deepak Gupta <deepakgdkg1g8868@gmail.com>
2021-10-18 20:28:17 +05:30
Chiranga Alwis 10846473ac
Add reference to the created scheduler configuration CM
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2021-10-18 10:21:13 +05:30
chirangaalwis 8e250cf405 Update references to invalid --scheduler-name arg 2021-10-16 15:02:45 +05:30
chirangaalwis 95be4e5e65 Update multiple scheduler with HA guide 2021-10-16 14:55:30 +05:30
chirangaalwis 6ec90297d0 Update multiple scheduler deployment guide 2021-10-16 13:31:18 +05:30
Kubernetes Prow Robot 87235b508d
Merge pull request #29311 from mengjiao-liu/update-githubbranch-param
Hard-code the name of the target repo's default branch instead of using the githubbranch parameter value
2021-08-16 06:03:18 -07:00
Mengjiao Liu f945335af6 Hard-code the name of the target repo's default branch instead of using the githubbranch parameter value 2021-08-10 18:03:21 +08:00
Dima Brusilovsky 91f4f4adf7
Update custom-resource-definition-versioning.md 2021-08-08 18:47:19 +03:00
Simone Tiraboschi eca82e08f9 Concretely explain how to patch CRD status
Current documentation simply suggest
"Remove v1beta1 from the CustomResourceDefinition
status.storedVersions field."
but this cannot be done just with kubectl and
it's not so intuitive.

Adding an example to make it more clear.

Signed-off-by: Simone Tiraboschi <stirabos@redhat.com>
2021-07-29 13:50:42 +02:00
John Gardiner Myers 63405a399a Use consistent terminology for the Kubernetes general CA 2021-07-03 13:50:42 -07:00
Kubernetes Prow Robot 0709b30d05
Merge pull request #28510 from chenxuc/28490
Correct command output in custom-resources example
2021-06-24 08:41:41 -07:00
chenxuc c2d7782e5a Correct command output
For issue #28490,
update command output to avoid confusion.
2021-06-20 16:03:08 +08:00
Kubernetes Prow Robot 5dfcf92490
Merge pull request #28447 from tengqm/fix-file-modes
Remove exec permission on markdown files
2021-06-17 19:04:04 -07:00
Qiming Teng e9703497a1 Remove exec permission on markdown files
For some unknown reasons, we have got many markdown files with exec
permission. That is weird and risky.
2021-06-16 17:57:00 +08:00
Kubernetes Prow Robot 2f4a570f0c
Merge pull request #27573 from dancnfoo/patch-1
Update custom-resource-definition-versioning.md
2021-06-09 19:57:26 -07:00
David Garvey 87364a0983
Add missing word 'be' 2021-04-26 13:53:16 +08:00
dancnfoo a38531234f
Update custom-resource-definition-versioning.md
`stored` should be `storage`
2021-04-15 11:50:24 -07:00
Karen Bradshaw 3ff5ec1eff clean up use of word: just 2021-03-17 19:57:40 -04:00
Vaibhav Goel 75fa920cf3
Update content/en/docs/tasks/extend-kubernetes/configure-multiple-schedulers.md
Co-authored-by: Qiming Teng <tengqm@outlook.com>
2021-03-15 12:39:28 +05:30
vaibhav b87508b7fb Linking a page 2021-03-12 21:31:00 +05:30
Nikhita Raghunath e5a17756a4 Remove feature-state tag for categories for CRDs
The Categories field for CRDs was documented as beta in 1.10 in #7439
mainly because CRDs were in beta back then.

The `feature-state` tag for this section was added in #2754, however
this section doesn't need a `feature-state` tag because the field is not
gated by any feature gate:

90851a0fb5/staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1/types.go (L247-L251)

It is now safe to remove the feature-state tag. Moreover, CRDs are now
GA so the beta state is not accurate.
2021-03-07 15:01:32 +05:30
Karen Bradshaw 7d9916af0c clean up use of word: easy 2021-02-01 15:14:25 -05:00
Kubernetes Prow Robot a5b0f7be9a
Merge pull request #25597 from apelisse/clarify-preserve-unknown
Clarify compatibility guarantees around spec.preserveUnknownFields
2021-01-14 11:18:55 -08:00
Antoine Pelisse fb1a0ca2e2 Address feedback 2021-01-14 10:54:51 -08:00
Xiang Dai b445946ce2 Update setup-konnectivity.md
Add missing volume config.
2020-12-16 11:45:41 +08:00
Antoine Pelisse a51a653764 Clarify compatibility guarantees around spec.preserveUnknownFields 2020-12-13 20:43:29 -08:00
Jefftree 3dc68c924b Add section for defaulting and nullable 2020-11-23 11:49:35 -05:00
Andrei Kvapil 798b5c9f2a
Add missing steps to configure konnectivity-server (#24141)
* Add missing steps to configure konnectivity-server

* Update content/en/docs/tasks/extend-kubernetes/setup-konnectivity.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

* Update content/en/docs/tasks/extend-kubernetes/setup-konnectivity.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

* Update content/en/docs/tasks/extend-kubernetes/setup-konnectivity.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

* update konnectivity manifests

* remove tcp configuration

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-11-12 23:52:23 -08:00
Jakob 8c68745c0f
improve structure of finalizer section in CRD guide (#24851)
- It's now more precise regarding the format of finalizers (which have to
  consist of a namespace and a name, separated by a forward slash or they
  will get rejected by the apiserver, with the exception of built in ones)
- It's less repetitve in general
2020-11-04 08:00:05 -08:00
Michael McCune de655df255 fix case for scale subresource fields
This change corrects the capitalization for the code blocks referring to
`statusReplicasPath` and `labelSelectorPath` to make the descriptive
text consistent with the code values.
2020-10-21 12:37:58 -04:00
Qiming Teng 321342b3f0 Fix nits in CRD task 2020-09-08 18:45:38 +08:00
Kubernetes Prow Robot 723b0863c6
Merge pull request #22754 from sftim/20200726_document_customresourcedefinition_stable
Document CustomResourceDefinition as stable
2020-08-26 14:53:03 -07:00
Savitha Raghunathan 95c94c03d5 resolving conflicts 2020-08-23 12:13:37 -04:00
Tim Bannister 85aaea2a99 Document CustomResourceDefinition as stable
Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
2020-08-22 14:14:47 +01:00