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

Enhance Bootstrap Node Deployment documentation #2114

Closed
thomasdanan opened this issue Dec 9, 2019 · 0 comments · Fixed by #2178
Closed

Enhance Bootstrap Node Deployment documentation #2114

thomasdanan opened this issue Dec 9, 2019 · 0 comments · Fixed by #2178
Assignees
Labels
topic:deployment Bugs in or enhancements to deployment stages topic:docs Documentation

Comments

@thomasdanan
Copy link
Contributor

thomasdanan commented Dec 9, 2019

Component:

'documentation'

Why this is needed:

https://metal-k8s.readthedocs.io/en/latest/quickstart/bootstrap.html
Some information are missing in this section

What should be done:

  • Better explain bootstrap configuration file
  • Describe all possible options (including proxy, ipip, etc …)
  • remove prometheus volume provisioning (as it is better to do it at the end of cluster installation)
  • build troubleshooting content in ops guide and provide a short link from there
  • Validate the install (pods running and access to the UI). Explain that monitoring from UI will not be available until prometheus volumes are provisioned

Implementation proposal (strongly recommended):

Test plan:

@thomasdanan thomasdanan added topic:docs Documentation topic:deployment Bugs in or enhancements to deployment stages moonshot labels Dec 9, 2019
@thomasdanan thomasdanan added this to the MetalK8s 2.4.2 milestone Dec 9, 2019
@thomasdanan thomasdanan changed the title Enhance Bootstrap Node Deployment section Enhance Bootstrap Node Deployment documentation Dec 9, 2019
@thomasdanan thomasdanan added this to To do in Week 51/2019 Dec 17, 2019
@gdemonet gdemonet added this to To do in Week 52/2019 Dec 31, 2019
@gdemonet gdemonet added this to To do in Week 02/2020 Jan 6, 2020
@gdemonet gdemonet moved this from To do to In progress in Week 02/2020 Jan 8, 2020
Ebaneck added a commit that referenced this issue Jan 9, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 9, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 9, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 9, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 9, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 10, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 10, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 10, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 13, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
@gdemonet gdemonet added this to In progress in Week 03/2020 Jan 13, 2020
Ebaneck added a commit that referenced this issue Jan 14, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 14, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 14, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 16, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 17, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
Ebaneck added a commit that referenced this issue Jan 17, 2020
This commit adds missing information to the bootstrap section
of MetalK8s documentation.

This commit adds:
Better explanation of the bootstrap configuration file
Describes the possible combinations of proxy and IPIP
Link to troubleshooting guide
Move of prometheus volume provisioning to post-install

Closes: #2114
@bert-e bert-e closed this as completed in 28e8778 Jan 18, 2020
Week 03/2020 automation moved this from In progress to Done Jan 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic:deployment Bugs in or enhancements to deployment stages topic:docs Documentation
Projects
No open projects
Week 02/2020
  
In progress
Week 03/2020
  
Done
Week 51/2019
  
To do
Week 52/2019
  
To do
Development

Successfully merging a pull request may close this issue.

2 participants