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

Improve the doc regarding the content of bootstrap.yaml file #1218

Open
nootal opened this issue Jun 13, 2019 · 2 comments
Open

Improve the doc regarding the content of bootstrap.yaml file #1218

nootal opened this issue Jun 13, 2019 · 2 comments

Comments

@nootal
Copy link
Contributor

nootal commented Jun 13, 2019

Component:

documentation

Why this is needed:

Because we are tempted to edit manually some parts of this file when we should not, and because some parts are unclear.

What should be done:

  • remove the harcoded "v1alpha2" version from the doc and from the test running during the execution.
  • specify that running the hostname command to get the true hostname is necessary
  • specify the IP address we want for apiServer is the one from the control plane network

Implementation proposal (strongly recommended):

  • edit documentation
  • remove the line that tests the version from salt/_pillar/metalk8s.py

Test plan:

  • bootstrap a node with another version and see if it works
@nootal nootal added this to Needs triage in MVP1 Issues via automation Jun 13, 2019
@gdemonet
Copy link
Contributor

remove the harcoded "v1alpha2" version from the doc and from the test running during the execution

No. That's the format version of the file, which will change with time. Although we could explain what it is in the docs, it's quite standard in the K8s world (users don't change the version when provided Pod/Deployment objects, for instance).

specify the IP address we want for apiServer is the one from the control plane network

This part also needs to be extended - we also support deploying keepalived for HA of k-a, which is configured in the same apiServer section.

@gdemonet gdemonet added the topic:docs Documentation label Jun 14, 2019
@gdemonet gdemonet added this to To do in Documentation via automation Jun 14, 2019
@nootal
Copy link
Contributor Author

nootal commented Jun 17, 2019

OK for the format version, I'll edit the ticket description.

And agreed for the keepalived stuff. But that's another story I guess.

@gdemonet gdemonet added this to Needs triage in Priorities Jun 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic:docs Documentation
Projects
Documentation
  
To do
MVP1 Issues
  
Needs triage
Priorities
  
Needs triage
Development

No branches or pull requests

2 participants