Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove docker installation steps from Administer Cluster docs #31059

Closed
wants to merge 1 commit into from
Closed

Remove docker installation steps from Administer Cluster docs #31059

wants to merge 1 commit into from

Conversation

championshuttler
Copy link
Contributor

Part of #30970

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 21, 2021
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Dec 21, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign jlbutler after the PR has been reviewed.
You can assign the PR to them by writing /assign @jlbutler in a comment when ready.

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

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Dec 21, 2021
@championshuttler championshuttler changed the base branch from main to dev-1.24 December 21, 2021 23:14
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 21, 2021
@championshuttler championshuttler changed the base branch from dev-1.24 to main December 21, 2021 23:14
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 21, 2021

Install Docker
Instructions to do so are available at [Install Docker Engine - Enterprise on Windows Servers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment?tabs=Windows-Server#install-docker).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tab actually starts on line 150 and continues to line 162.

Instead of removing one of the 2 tabs, I would tell readers that they must install a container runtime and list some compatible ones. Rather than providing the instructions, we hyperlink to them.

For example:

  • containerd
  • Mirantis Container Runtime

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also link to https://github.com/kubernetes-sigs/sig-windows-tools/ to let readers know that there might be a helper script for your preferred runtime.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to this suggestion

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@championshuttler following up here, are you willing to incorporate Tim's suggestion? thanks

Copy link
Contributor

@divya-mohan0209 divya-mohan0209 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL at the suggestions provided by Tim


Install Docker
Instructions to do so are available at [Install Docker Engine - Enterprise on Windows Servers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment?tabs=Windows-Server#install-docker).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to this suggestion

@chrisnegus
Copy link
Contributor

/assign @celestehorgan

@@ -146,20 +146,6 @@ All code snippets in Windows sections are to be run in a PowerShell environment
with elevated permissions (Administrator) on the Windows worker node.
{{< /note >}}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{< tabs name="tab-windows-kubeadm-runtime-installation" >}}

See @sftim's comment that the tab starts on line 150

@neolit123
Copy link
Member

neolit123 commented Jan 25, 2022

i have a PR that overlaps with the kubeadm / windows install sections in this PR:
#31309

ideally this PR should be rebased on top of mine, if needed, as mine touches all kubeadm docs related to the Docker change.

EDIT: also this PR seems to be against "main", and should be against dev-1.24 instead?

@sftim
Copy link
Contributor

sftim commented Jan 25, 2022

@neolit123 the easiest thing to do overall is if you can add a commit to #31309 that makes the appropriate changes, and list @championshuttler as co-author. Would you have time to do that?

If we pick that approach, we can close this PR.

@neolit123
Copy link
Member

@sftim
i did not check the diff here properly.
this PR is not needed after my change in #31309

@neolit123
Copy link
Member

also looks like @marosset from SIG Windows just LGTM-ed my PR.
follow ups on formatting can be done separately.

@sftim
Copy link
Contributor

sftim commented Jan 25, 2022

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 25, 2022
@jihoon-seo
Copy link
Member

Since

and also Netlify build fails,
and author is not responding to comments or feedback in 2 or more weeks,
it might be better to close this PR. 😊
/close

@k8s-ci-robot
Copy link
Contributor

@jihoon-seo: Closed this PR.

In response to this:

Since

and also Netlify build fails,
and author is not responding to comments or feedback in 2 or more weeks,
it might be better to close this PR. 😊
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants