documents steps to install components to support baremetal clusters deploy #230
Conversation
vjayaramrh
requested review from
arora-sagar,
dkosteck and
liamfallon
and removed request for
efiacor and
timop62
✅ Deploy Preview for nephio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
vjayaramrh
changed the title
|
NOTE: This PR is related to the PRs in the catalog repo |
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
|
|
||
| {{% alert title="Note" color="primary" %}} | ||
|
|
||
| If you want to use a version other than that of v3.0.0 of Nephio *catalog* repo, then replace the *@origin/v3.0.0* |
There was a problem hiding this comment.
Why can't we give an example of v4.0.0?
There was a problem hiding this comment.
I just used the template at https://docs.nephio.org/docs/guides/install-guides/optional-components/ to create this document and left the Note as is. No plans to update the document everytime there is a new release is done. The content in the Note is an example.
| internal.kpt.dev/upstream-identifier: '|ConfigMap|baremetal-operator-system|baremetal-operator-ironic-bmo-configmap-6cf9t7484b' | ||
| ``` | ||
|
|
||
| The IP address 172.22.0.2 that is present in the fields DEPLOY_KERNEL_URL, DEPLOY_RAMDISK_URL, IRONIC_BASE_URL, |
There was a problem hiding this comment.
@vjayaramrh Can you make a diagram for networking? How the actual network connection look like? This helps people to understand what is needed before installation.
There was a problem hiding this comment.
@arora-sagar I am not sure what network diagram would look like for installing the Metal3, Baremetal Operator(BMO) and ironic on a management cluster. I did look up the BMO and ironic documentation and could not find any network diagrams to refer. However, I am willing to collaborate with you to come up with the diagram if you have an idea.
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
| mkdir -p /tmp/baremetal_kpt | ||
| cd /tmp/baremetal_kpt | ||
|
|
||
| kpt pkg get https://github.com/nephio-project/catalog/infra/capi/cluster-capi-infrastructure-metal3@main metal3 |
There was a problem hiding this comment.
I believe it would definitely help to create a simple diagram showing the setup with Nephio mgmt cluster along with ironic, metal3 and bmo hosted on a VM/Physical machine and connected to a LAN network (172.22.0.1 subnet over eth2 interface) also having connections to other VM/Physical machines which needs to be provisioned
Also, would be better to define kpt get and apply steps for each of 3 packages separately one-by-one with some validation steps if possible
There was a problem hiding this comment.
@gkumar78 Thanks for the feedback, please do share any diagrams that you may have that I could re-use, Thanks
There was a problem hiding this comment.
@vjayaramrh As discussed, let us wait for addition of network diagram in the upcoming set of PRs on this topic. More details will be clear as well as the approach will get validated. And we can add network diagram thereafter.
But I would stick to my other comment that it would be better to define kpt get and apply steps for each of 3 packages separately one-by-one with some validation steps
There was a problem hiding this comment.
@vjayaramrh As discussed, let us wait for addition of network diagram in the upcoming set of PRs on this topic. More details will be clear as well as the approach will get validated. And we can add network diagram thereafter.
But I would stick to my other comment that it would be better to define kpt get and apply steps for each of 3 packages separately one-by-one with some validation steps
FYI The kpt get is called out for each of the packages, the kpt eval is applied across the packages (where applicable) instead of apply customizations to one package at a time. The kpt live init and kpt live apply are applied across packages as well at the same time due to CAPI Metal3 dependent on CRDs installed by BMO and ironic.
vjayaramrh
force-pushed
the
capm3-bmo-ironic
branch
2 times, most recently
from
6e07eed to
8b27e15
Compare
vjayaramrh
force-pushed
the
capm3-bmo-ironic
branch
from
8b27e15 to
52565b0
Compare
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Gergely Csatari <gergely.csatari@nokia.com>
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
content/en/docs/guides/install-guides/baremetal-infra-components.md
Outdated
Show resolved
Hide resolved
| ```bash | ||
| kpt fn render --truncate-output=false | ||
|
|
||
| # Sample output of above command below |
There was a problem hiding this comment.
Better to put the sample output into a separate bash block
| ```bash | ||
| kubectl get pods --all-namespaces | grep -E '^(capm3-system|baremetal-operator-system)' | ||
|
|
||
| baremetal-operator-system baremetal-operator-controller-manager-5c55b458cf-bcbkd 1/1 Running 0 28d |
There was a problem hiding this comment.
Break the sample out to a separate block
There was a problem hiding this comment.
you mean separate out the command and its output?
| capm3-system ipam-controller-manager-69f4dd4cdf-zgl55 1/1 Running 0 28d | ||
| ``` | ||
|
|
||
| ## Baremetal cluster creation . |
There was a problem hiding this comment.
Should this be a separate doc?
There was a problem hiding this comment.
I am not sure, open for suggestions.
|
|
||
| ## Baremetal cluster creation . | ||
|
|
||
| Note that only a single node cluster with IPv4 static IP addressing is supported at this time. |
There was a problem hiding this comment.
Wrap the NOTEs with the common tpl
| kubectl get clusters | ||
| ``` | ||
|
|
||
| NOTE: The network diagram highlights simple connection between Nephio management cluster (provisioning cluster) and workload cluster (target). The diagram does not consider switches or routers. If you are using switches then make sure the connectivity is properly configured. |
There was a problem hiding this comment.
Wrap the NOTEs in the common tpl
Co-authored-by: Gergely Csatari <gergely.csatari@nokia.com> Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: efiacor The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
pushed in due to prow failure |
6 participants
This PR adds step by step instructions to deploy the metal3, baremetal and ironic operator components.