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.

Sign up for GitHub

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

Jump to bottom

Add machine controller documentation #1696

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add machine controller documentation #1696

wants to merge 7 commits into from

Conversation

xrstf
Copy link
Contributor

@xrstf xrstf commented May 31, 2024

This PR moves all MC documentation out of the MC repository and copies it into this one.

@kubermatic-bot kubermatic-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels May 31, 2024
@kubermatic-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from xrstf. For more information see the Kubernetes Code Review Process.

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

@kubermatic-bot
Copy link
Contributor

Issues go stale after 90d of inactivity.
After a furter 30 days, they will turn rotten.
Mark the issue as fresh with /remove-lifecycle stale.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@kubermatic-bot kubermatic-bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 29, 2024
@kubermatic-bot
Copy link
Contributor

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

@kubermatic-bot kubermatic-bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Sep 29, 2024
@xrstf xrstf changed the title WIP - Add machine controller documentation Add machine controller documentation Sep 30, 2024
@kubermatic-bot kubermatic-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 30, 2024
@xrstf xrstf removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale. label Sep 30, 2024
xmudrii
xmudrii reviewed Sep 30, 2024
View reviewed changes
content/machine-controller/_index.en.md Outdated Show resolved Hide resolved
content/machine-controller/_index.en.md Outdated Show resolved Hide resolved
content/machine-controller/_index.en.md Outdated Show resolved Hide resolved
content/machine-controller/_index.en.md Show resolved Hide resolved
content/machine-controller/cloud-providers/_index.en.md Outdated Show resolved Hide resolved
content/machine-controller/cloud-providers/vsphere/_index.en.md
* 6.5
* 6.7

## Template VMs preparation
Copy link
Member

Choose a reason for hiding this comment

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

We should consider dropping this and linking to the document that we have in the KubeOne docs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I feel extremely uneasy about relying on a 3rd party project, that builds on the machine-controller, for documenting the machine-controller. Why should KubeOne document how the MC works?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can / Should we move the K1 docs for image management to MC?

Copy link
Member

Choose a reason for hiding this comment

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

I think that would make sense, to move the documents to the MC docs

content/machine-controller/guides/custom-registry/_index.en.md Outdated Show resolved Hide resolved
content/machine-controller/guides/proxy/_index.en.md
nodes to use this proxy. For this the following flag must be set on the machine-controller side:

```bash
-node-http-proxy="http://192.168.1.1:3128"
Copy link
Member

Choose a reason for hiding this comment

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

This flag is no-op actually 😬 It's now integrated into OSM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So what do? Remove the entire page?

Copy link
Member

Choose a reason for hiding this comment

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

I think removing the entire page is a good solution

content/machine-controller/guides/registry-authentication/_index.en.md
@@ -0,0 +1,57 @@
+++
title = "Registry Authentication"
Copy link
Member

Choose a reason for hiding this comment

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

This might also be part of OSM now, but should be double checked

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So what do? Remove the entire page?

Copy link
Member

Choose a reason for hiding this comment

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

I think removing the entire page is a good solution

content/machine-controller/operating-systems/_index.en.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xmudrii xmudrii xmudrii left review comments

Assignees
No one assigned
Labels
dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xrstf @kubermatic-bot @xmudrii