Commit Graph

57 Commits (aae228c0377a677b59df6543f0b51cd21fcab176)

Author SHA1 Message Date
hacktivist123 e6d2e1499d Merge main into dev-1.31 to keep in sync 2024-07-29 18:03:33 +01:00
Kubernetes Prow Robot 1b47e81c5f
Merge pull request #46263 from MikeSpreitzer/fix-46262
Clarify remark about object names wrt CRD
2024-07-28 13:19:32 -07:00
Joe Betz 8f1e148864
KEP-4358: Custom Resource Field Selectors: Promote to Beta (#46980)
* KEP-4358: Custom Resource Field Selectors: Promote to Beta

* Update content/en/docs/reference/command-line-tools-reference/feature-gates/custom-resource-field-selectors.md

Co-authored-by: Dipesh Rawat <rawat.dipesh@gmail.com>

* Remove alpha level notes about enabling the feature

* Update content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md

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

* Update content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md

Co-authored-by: lakshmi prasuna <56723673+T-Lakshmi@users.noreply.github.com>

* Update content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md

Co-authored-by: lakshmi prasuna <56723673+T-Lakshmi@users.noreply.github.com>

---------

Co-authored-by: Dipesh Rawat <rawat.dipesh@gmail.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: lakshmi prasuna <56723673+T-Lakshmi@users.noreply.github.com>
2024-07-26 16:53:58 -07:00
Mike Spreitzer 279c81eb26
Clarify remark about object names wrt CRD
Signed-off-by: Mike Spreitzer <mspreitz@us.ibm.com>
2024-07-24 00:44:51 -04:00
Charlie Le 712686dcbd
Update custom-resources.md
Removes extraneous 'with'.
2024-06-01 20:48:20 -07:00
Daniel Chan cdf1ed1236 Merge remote-tracking branch 'upstream/main' into dev-1.30
Merge main into dev-1.30 to keep in sync
2024-04-02 10:05:03 -04:00
Joe Betz 8c0a57a1e1 Add docs for CRD field selection 2024-03-18 11:09:04 -04:00
Dipesh Rawat c889d9b251
Add metadata to use mechanism for API reference links 2024-03-14 14:50:24 +00:00
Alexander Zielenski e894028da7 move to other pages, add links 2023-08-07 22:10:04 -07:00
Tim Bannister 634c17f61c Reorganize Working with Kubernetes Objects section
- move Understanding Kubernetes Objects to be section overview
- within the section, consistently link to the new (moved) page from the
  first mention of “object”
- add a redirect

Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>
2023-04-29 21:39:42 +01:00
Qiming Teng 888c244394 Tweak line wrapping in the custom-resource concept page
This PR fixes the long line problems found in the custom-resources.md
concept page. Saddly, there are some markdown tables we cannot fix yet
in this PR. Maybe a HTML table is a better alternative.
2022-10-08 16:46:25 +08:00
Kubernetes Prow Robot 781edc66f9
Merge pull request #34734 from sftim/20220628_update_extend_kubernetes_concept_overview
Update “Extend Kubernetes” concept overview
2022-09-22 18:08:39 -07:00
Tim Bannister dd615623bc Tweak custom resources concept
- Use capitalizations as per style guide
- Use glossary tooltips where appropriate
2022-08-27 15:06:07 +01:00
Tim Bannister 4f9ca16794 Revise “Extending Kubernetes” concept
- Rework section index page
- Use more glossary tooltips
- Mention APIService more clearly
- Shift CRD note to the overview page for API extensions
2022-07-18 21:29:27 +01: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
Wang 2d560fd4fb
Update custom-resources.md 2021-11-10 05:07:02 +09:00
Wang 324e4e07fa
[en] update custom-resources
Make it clear that the main API server delegates requests to user created API server.
2021-11-09 18:31:31 +09:00
Kubernetes Prow Robot b50819e5f9
Merge pull request #29349 from jaypipes/controller-dec-api
clarify declarative API in custom controller docs
2021-09-29 09:10:50 -07:00
Jay Pipes 6a4dddd251 clarify declarative API in custom controller docs
The content describing a declarative API in the custom controller
section of the custom resources doc was confusing:

> A declarative API allows you to declare or specify the desired state
of your resource **and tries to keep the current state of Kubernetes
objects in sync with the desired state**. The controller interprets the
structured data as a record of the user's desired state, and continually
maintains this state.

(emphasis added)

It is not the declarative API that tries to keep the current state of
the objects in sync with the desired state. It's the controller that
does that.

I've reworded this paragraph to hopefully clarify this.

Closes Issue #29348

Signed-off-by: Jay Pipes <jaypipes@gmail.com>
2021-09-28 16:19:54 -04:00
deepsan 788b9ce132 Reword Go requirement for Aggregated API
Given 'Aggregated APIs are subordinate API servers that sit behind the primary API server, which acts as a proxy', the comparison table indicates a requirement for the subordinate API servers to use Go, when it is not a requirement as long as the subordinate API server follows the expected contract
2021-08-05 15:07:43 -07:00
Xiaopeng Han ecede1568a
update the correct operator link
The original link of `operator pattern` is a meaningless page. This commit updates the link to the correct `operator pattern` page.
2021-03-29 11:54:32 +08:00
Karen Bradshaw 3fd65482e8 clean up use of word: simply 2021-02-07 12:15:29 -05:00
Tim Bannister 3edb970570 Move API overview to be a Docsy section overview 2020-10-20 23:41:54 +01:00
Qiming Teng c8f4704873 Fix links in concepts section (2) 2020-08-02 09:11:14 +08:00
Jerry Park ffe0090d2c Fix with concepts/extend-kubernetes/api-extension/custom-resources/ 2020-06-22 09:32:29 +00:00
Karen Bradshaw 5fe8c3ca5e move setup konnectivity svc
move api-access to extend-kubernetes
2020-06-10 16:06:01 -04:00
Karen Bradshaw ecc27bbbe7 add en pages 2020-06-09 19:33:15 -04:00
Prasad Katti 1481e711c6 Move update-api-object-kubectl-patch.md to be under 'Manage Kubernetes Objects' section 2020-05-18 09:25:13 -07:00
Vinicius Barbosa ded2612866
Update content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md
Co-Authored-By: Jim Angel <jimangel@users.noreply.github.com>
2020-04-21 07:32:37 -03:00
Vinicius Barbosa 7119fa1c27
Merge branch 'master' into patch-1 2020-04-21 00:26:19 -03:00
Ali Mirlou 2060adcc0d Minor refactor and typo fix of Custom Resources topic
Revert a change in Custom Resources topic

Revert Latin phrases to original form

Update custom-resources.md
2020-04-12 00:37:50 +00:00
Vinicius Barbosa 8acfed97b7
Update custom-resources.md 2020-04-09 15:12:57 -03:00
Tim Bannister c5d7d32151
Reword API Server aggregation (#19141)
* Reword API Server aggregation

* Document custom resources ahead of APIService

CustomResourceDefinition is the newer, shinier and often more
appropriate resource to help with cases where APIService was not a good
fit. Switch order to mention the custom resources page first, which
introduces both APIService and CustomResourceDefinition.
2020-03-15 21:46:35 -07:00
Enshin Andrey 04b20e1dce
Update custom-resources.md (#19597) 2020-03-15 20:38:35 -07:00
Sharjeel Aziz 65c92bfbe3
Minor formatting fix (#19356)
Converted bullets to paragraphs to fix formatting in Advanced features and flexibility table.

Signed-off-by: sharjeelaziz <sharjeel.aziz@gmail.com>
2020-02-29 17:46:39 -08:00
Qiming Teng 6318dbb124
Resource name constraints (2) (#19119)
xref: #17969, #19099, #18746
2020-02-28 12:10:38 -08:00
Andrew Allbright 470f932dd8
Latin Abbreviations "vs" Updated to "versus" (#19181)
* grep -lR ' vs ' ./content/en/docs | xargs sed -i '' -e 's/ vs / versus /g'

* Update content/en/docs/concepts/configuration/overview.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Update content/en/docs/concepts/policy/resource-quotas.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-02-19 00:14:25 -08:00
Tim Bannister 2faf1024d9
Tweak linking for Kubernetes object concept (#18122)
- Add a link from /docs/reference/using-api/api-concepts/
- Tweak other incoming links to match
2020-02-10 19:24:01 -08:00
Josh Soref 48fb48d882
Grammar (#18785)
* grammar: 'to' distributes over 'or'

* grammar: reword

per app.grammarly.com

* grammar: simplify

from app.grammarly.com

* spelling: etc.
2020-01-29 14:20:14 -08:00
Damini Satya dff2f7b960 Official 1.17 Release Docs (#18011)
* feat: graduate TaintNodesByCondition to GA (#17073)

* Promote StartupProbe to beta (enabled by default). (#17164)

* Watch bookmarks to GA (#17026)

* feat: graduate ScheduleDaemonSetPods to GA (#17350)

* Update Docker installation instructions (#17405)

* Use exact version numbers for installing Docker in Ubuntu (#17428)

* Move CSIMigration and CSIMigrationGCE to Beta in Kubernetes v1.17 (#17478)

* Promote NodeLease feature to GA (#17189)

* Update docs for csi topology ga (#17408)

* Update RunAsUsername to beta (#17460)

* doc:Update RunAsUsername to beta

* doc: update samples - kubernetes.io/os is no longer beta

* Updating based on review feedback

* Promote Node-specific volume limits to GA (#17432)

* Promote PodShareProcessNamespace to stable (#17192)

* Promote PodShareProcessNamespace to stable

* Add for_k8s_version to feature-state label

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Readd version-check to shareProcessNamespace task

* Update service load balancer finalizer doc for GA (#17438)

* Update Topology Manager docs (#17451)

* Added information on how device plugins can take advantage
of Topology Manager
* Updated the Topology Manager documentation to include additionalinformation and update some out of date sections

* Fix broken Topology Manager link (#17746)

Part of What's Next Device Plugin section

* Update CRD defaulting docs for GA (#17450)

* Add documentation for VolumeSnapshot Beta (#17233)

* Updating EndpointSlice documentation for beta release in 1.17 (#17411)

* (docs/dualstack): v1.17 updates (#17457)

* Add placehold doc updates for dualstack in 1.17

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Add Downward API and /etc/hosts Pod IP validation

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* remove addressed known issue via k/k pr 85246

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Remove known issue and add flag as part of k/k 79993

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* remove follow up placeholders

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update verbiage

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Make IP addressing consistent throughout the task

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update to status.podIPs

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update content/en/docs/tasks/network/validate-dual-stack.md

Use set instead of env

Co-Authored-By: Khaled Henidak (Kal) <khnidk@outlook.com>

* add topology.kubernetes.io/zone, topology.kubernetes.io/region and node.kubernetes.io/instance-type labels to docs (#17498)

Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

* Service topology alpha documentation (#17459)

* Update list of feature flags for in-tree plugins migrated to CSI (#17533)

Signed-off-by: Deep Debroy <ddebroy@docker.com>

* Update Node concept for TaintNodesByCondition going GA (#17577)

* feat: graduate ResourceQuotaScopeSelectors to GA in 1.17 (#17554)

* kubeadm: update the upgrade documentation for 1.17 (#17587)

* doc: Simplify Windows deployments with RuntimeClass (#16697)

* doc: Simplify Windows deployments with RuntimeClass

* Updating on review feedback

* doc: Adding windows-build label from enhancement 1301

* update doc for kubelet option --reserved-cpus (#17648)

* feat: update TaintNodesByCondition in feature gates table (#17377)

* Update docs for v1 resource quota configuration (#17547)

* AdmissionConfiguration v1 (#17548)

* Update WebhookAdmissionConfiguration examples (#17549)

* Update AWS EBS Migration Feature state (#16126)

* Add resource version section to api-concepts documentation (#16910)

* Add Resource Version semantics section to api concepts

* Clarify risks of going back in time, add details about compaction and watch cache sizes

* Apply suggestions from liggitt

Co-Authored-By: Jordan Liggitt <jordan@liggitt.net>

* remove pesudocode, apply feedback

* Fix typo

* Clarify equality rules

* Cleanup kubectl generators docs (#17609)

* Write ReplicationController without a space

* Drop mentioning unsupported cluster versions

* Fix capitalization for “API group”

* Tweak wording

* Avoid using deprecated generator in example

* add Antrea description in dev-1.17 (#17919)

* Promote VolumeSubpathEnvExpansion to GA

* Reference Documentation for the Kubernetes API for 1.17 (#18019)

* Update feature-gates.md (#18033)

* Reference Documentation for kubectl Commands for 1.17 (#18017)

* Update for v1.17 (#18034)

* Update config.toml(release-1.17) for 1.17 (#18031)
2019-12-09 16:11:29 -08:00
Dr. Stefan Schimanski 99482ef7c4 CRDs: promote to v1 (#15982) 2019-09-06 07:33:00 -07:00
Dr. Stefan Schimanski 57f6eeee68 concepts/extend-kubernetes/api-extension: add 1.15 features (#14583) 2019-06-10 22:54:14 -07:00
chenrui 5a5f77db64 Fix relative links issue in English content (#13307)
* `http://kubernetes.io/docs/` -> `/docs/` in content/en folder

* `https://kubernetes.io/docs/` -> `/docs/` in content/en folder
2019-03-20 16:05:05 -07:00
Michael Vorburger ⛑️ 92132a4f0c fix minor typo (missing "to") in custom resources doc (#13005) 2019-03-07 16:12:09 -08:00
Misty Linville 928f7094cb Small refactor of Custom Resources topic (#12502)
- Adjusts levels
- Removes some obsolete info
- Rewrite of some of the intro material
2019-02-27 20:53:31 -08:00
yanghaichao12 7408605d04 Fix some grammar errors in custom-resources.md (#11476) 2018-12-04 01:36:24 -08:00
chenDT bfefb311b9 fix some 404 errors (#11352) 2018-11-27 01:29:22 -08:00
yanghaichao12 3154c260e9 Fix an error in custom-resources.md (#11020) 2018-11-16 10:29:24 -08:00
Nikhita Raghunath cb11cce55c Update current state of features for custom resources (#10994) 2018-11-14 14:27:09 -08:00
Karen Bradshaw b38adb0075 update, remove third party resource links (#11001) 2018-11-14 14:25:39 -08:00