API reference v1.23 #29668

feloy · 2021-09-11T09:55:05Z

Changes to the API reference for the upcoming v1.23

netlify · 2021-09-11T10:07:59Z

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: 294c5dc

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/613c7cfbb4d2c40008f2851d

😎 Browse the preview: https://deploy-preview-29668--kubernetes-io-main-staging.netlify.app

sftim · 2021-09-12T11:05:28Z

/milestone 1.23

jimangel · 2021-09-13T20:41:07Z

@feloy thanks for getting a jump start on this! Is the plan to test it now and re-run it once SIG Release starts cutting release candidates (rc)?

feloy · 2021-09-13T20:56:11Z

@jimangel my idea is to update this PR as soon as new alpha/beta/RC are released, as is it easier to incorporate API changes by small chunks.

reylejano · 2021-09-14T20:04:24Z

/cc @jlbutler @mehabhalodiya @chrisnegus @ramrodo @nate-double-u (1.23 Docs Release Team)

jlbutler · 2021-09-15T14:14:11Z

/assign

netlify · 2021-11-13T07:48:19Z

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

🔨 Explore the source changes: 0244593

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/61b06e597ef02800089a8e83

sftim · 2021-11-28T19:09:40Z

content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2.md

@@ -1,11 +1,11 @@
 ---
 api_metadata:
-  apiVersion: "autoscaling/v2beta2"


Will this change mean that the docs for HorizontalPodAutoscaler autoscaling/v2beta2 disappear? This might surprise readers given that lots of tools do use this API at autoscaling/v2beta2.

Yes, this change will make it disappear. I will check if we can have both v2beta2 and v2 in documentation

@sftim I've updated the doc to display v1, v2beta2 and v2 for HorizontalPodautoscaler:
https://deploy-preview-29668--kubernetes-io-vnext-staging.netlify.app/docs/reference/kubernetes-api/workload-resources/

The problem is that versions are not displayed in the titles for non beta versions, and thus it is difficult to distinguish between v1 and v2

What would we like to do?

have only v2 and v2beta2?

always display the versions in the title (this will display v1 for a lot of resources)

(2) will need to update the program building the documentation, where (1) only needs to modify the configuration in this repository.

Could we countenance a manual tweak, post build, for just the HPA APIs to show v1 and v2 explicitly, possibly followed by a logic tweak to show the version any time there are multiple stable APIs?

If we go for the logic tweak, SIG Docs can look for someone to pick up that work (ie: it doesn't have to be you @feloy - you already help a lot here!)

We should definitely aim to leave in docs for HPA v1; until the v1.23 release it's the API we officially recommend (v2beta2 is, of course, only beta). The day after that release folks would still expect to see docs for that v1 API available.

What do you prefer @feloy ?

Could we countenance a manual tweak, post build, for just the HPA APIs to show v1 and v2 explicitly, possibly followed by a logic tweak to show the version any time there are multiple stable APIs?

If we go for the logic tweak, SIG Docs can look for someone to pick up that work (ie: it doesn't have to be you @feloy - you already help a lot here!)

@sftim, Yes, it would be nice to have someone make some manual tweak after build with the necessary changes, so I can work on the logic one once I have a precise example of what to do.

jimangel · 2021-12-05T22:50:51Z

@feloy checking in, anything needed before Tuesday's release that we need to draw attention to?

/cc @jlbutler

feloy · 2021-12-06T08:15:16Z

@feloy checking in, anything needed before Tuesday's release that we need to draw attention to?

/cc @jlbutler

No, this PR is up to date for v1.23 rc1.

tengqm · 2021-12-07T01:04:20Z

although RC1 is the near complete version of 1.23, I'd still prefer deferring this to the formal release.

kbhawkey · 2021-12-07T01:13:19Z

Page previews:
https://deploy-preview-29668--kubernetes-io-vnext-staging.netlify.app/docs/reference/kubernetes-api/

Field introduced in 1.23:
https://deploy-preview-29668--kubernetes-io-vnext-staging.netlify.app/docs/reference/kubernetes-api/common-parameters/common-parameters/#fieldValidation

https://deploy-preview-29668--kubernetes-io-vnext-staging.netlify.app/docs/reference/kubernetes-api/workload-resources/pod-v1/#parameters-6
https://deploy-preview-29668--kubernetes-io-vnext-staging.netlify.app/docs/reference/kubernetes-api/workload-resources/cron-job-v1/

kbhawkey · 2021-12-07T01:18:00Z

although RC1 is the near complete version of 1.23, I'd still prefer deferring this to the formal release.

OK, that's fair. We can post another build as soon as the release is available.
/lgtm

k8s-ci-robot · 2021-12-07T01:18:21Z

LGTM label has been added.

Git tree hash: 3cacc338c7690ed77bd4f125b93d781f7d6d37ea

jlbutler · 2021-12-07T14:01:50Z

Ok that works. I'll check back once we have a release tag for 1.23.0 and we can go from there. Thanks all!

jlbutler · 2021-12-07T21:04:33Z

The release tag v1.23.0 is published. Is someone available to refresh this PR with a release build?

@kbhawkey @feloy

jlbutler · 2021-12-08T03:42:55Z

Hi @feloy 👋

1.23 is released and 1.23.0 tag is available. Can you rebuild/refresh this PR, and then rebase to main? Thanks!

feloy · 2021-12-08T08:36:37Z

Hi @feloy wave

1.23 is released and 1.23.0 tag is available. Can you rebuild/refresh this PR, and then rebase to main? Thanks!

Hi @jlbutler I've updated to 1.23.0 tag, and rebased to main branch. Thanks

sftim · 2021-12-08T09:11:19Z

/remove-language zh
/approve

sftim · 2021-12-08T09:11:28Z

/remove-area blog

k8s-ci-robot · 2021-12-08T09:11:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [sftim]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sftim · 2021-12-08T21:24:19Z

I'd expect that https://deploy-preview-29668--kubernetes-io-main-staging.netlify.app/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2/ would work - and it doesn't.

Even so, I've no objection to these changes going live, and then further fixups.

feloy · 2021-12-08T21:31:01Z

@sftim you can get a preview at https://deploy-preview-29668--kubernetes-io-vnext-staging.netlify.app/docs/reference/kubernetes-api/

kbhawkey · 2021-12-09T00:53:59Z

Page preview:
https://deploy-preview-29668--kubernetes-io-vnext-staging.netlify.app/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2beta2/

kbhawkey · 2021-12-09T00:56:01Z

Thanks @feloy .
/lgtm

k8s-ci-robot · 2021-12-09T00:56:21Z

LGTM label has been added.

Git tree hash: e86d0ff719db8f93b76e902e77f05c30fc057b49

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 11, 2021

k8s-ci-robot requested review from jimangel and pjbgf September 11, 2021 09:55

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Sep 11, 2021

feloy changed the base branch from main to dev-1.23 September 11, 2021 09:55

k8s-ci-robot added this to the 1.23 milestone Sep 12, 2021

k8s-ci-robot requested review from chrisnegus, jlbutler, mehabhalodiya, nate-double-u and ramrodo September 14, 2021 20:04

k8s-ci-robot assigned jlbutler Sep 15, 2021

feloy force-pushed the apiref-1.23 branch from 294c5dc to 3ad18cb Compare November 13, 2021 07:48

feloy force-pushed the apiref-1.23 branch from 3ad18cb to 50facbf Compare November 13, 2021 08:05

sftim reviewed Nov 28, 2021

View reviewed changes

feloy force-pushed the apiref-1.23 branch from f6d52e4 to 6f7dd14 Compare December 2, 2021 15:38

feloy force-pushed the apiref-1.23 branch 2 times, most recently from f0c012b to ca646e0 Compare December 6, 2021 08:14

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2021

jlbutler removed this from the 1.23 milestone Dec 8, 2021

Reference docs for kubernetes 1.23

0244593

feloy force-pushed the apiref-1.23 branch from ca646e0 to 0244593 Compare December 8, 2021 08:35

k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject language/zh Issues or PRs related to Chinese language and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Dec 8, 2021

feloy changed the base branch from dev-1.23 to main December 8, 2021 08:38

k8s-ci-robot removed the language/zh Issues or PRs related to Chinese language label Dec 8, 2021

k8s-ci-robot removed the area/blog Issues or PRs related to the Kubernetes Blog subproject label Dec 8, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 8, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 9, 2021

k8s-ci-robot merged commit a50b7b9 into kubernetes:main Dec 9, 2021

feloy mentioned this pull request Aug 1, 2022

Mark EphemeralContainers as GA in 1.25 #35545

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API reference v1.23 #29668

API reference v1.23 #29668

feloy commented Sep 11, 2021

netlify bot commented Sep 11, 2021

sftim commented Sep 12, 2021

jimangel commented Sep 13, 2021

feloy commented Sep 13, 2021

reylejano commented Sep 14, 2021 •

edited

Loading

jlbutler commented Sep 15, 2021

netlify bot commented Nov 13, 2021 •

edited

Loading

sftim Nov 28, 2021

feloy Nov 29, 2021

feloy Dec 2, 2021

sftim Dec 2, 2021

sftim Dec 2, 2021

sftim Dec 2, 2021

feloy Dec 3, 2021

jimangel commented Dec 5, 2021

feloy commented Dec 6, 2021

tengqm commented Dec 7, 2021

kbhawkey commented Dec 7, 2021

kbhawkey commented Dec 7, 2021

k8s-ci-robot commented Dec 7, 2021

jlbutler commented Dec 7, 2021

jlbutler commented Dec 7, 2021

jlbutler commented Dec 8, 2021

feloy commented Dec 8, 2021

sftim commented Dec 8, 2021

sftim commented Dec 8, 2021

k8s-ci-robot commented Dec 8, 2021

sftim commented Dec 8, 2021

feloy commented Dec 8, 2021

kbhawkey commented Dec 9, 2021

kbhawkey commented Dec 9, 2021

k8s-ci-robot commented Dec 9, 2021

API reference v1.23 #29668

API reference v1.23 #29668

Conversation

feloy commented Sep 11, 2021

netlify bot commented Sep 11, 2021

sftim commented Sep 12, 2021

jimangel commented Sep 13, 2021

feloy commented Sep 13, 2021

reylejano commented Sep 14, 2021 • edited Loading

jlbutler commented Sep 15, 2021

netlify bot commented Nov 13, 2021 • edited Loading

sftim Nov 28, 2021

Choose a reason for hiding this comment

feloy Nov 29, 2021

Choose a reason for hiding this comment

feloy Dec 2, 2021

Choose a reason for hiding this comment

sftim Dec 2, 2021

Choose a reason for hiding this comment

sftim Dec 2, 2021

Choose a reason for hiding this comment

sftim Dec 2, 2021

Choose a reason for hiding this comment

feloy Dec 3, 2021

Choose a reason for hiding this comment

jimangel commented Dec 5, 2021

feloy commented Dec 6, 2021

tengqm commented Dec 7, 2021

kbhawkey commented Dec 7, 2021

kbhawkey commented Dec 7, 2021

k8s-ci-robot commented Dec 7, 2021

jlbutler commented Dec 7, 2021

jlbutler commented Dec 7, 2021

jlbutler commented Dec 8, 2021

feloy commented Dec 8, 2021

sftim commented Dec 8, 2021

sftim commented Dec 8, 2021

k8s-ci-robot commented Dec 8, 2021

sftim commented Dec 8, 2021

feloy commented Dec 8, 2021

kbhawkey commented Dec 9, 2021

kbhawkey commented Dec 9, 2021

k8s-ci-robot commented Dec 9, 2021

reylejano commented Sep 14, 2021 •

edited

Loading

netlify bot commented Nov 13, 2021 •

edited

Loading