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

Docs updates for Baremetal configuration #6860

Closed
wants to merge 1 commit into from

Conversation

mitalipaygude
Copy link
Member

Issue #, if available:

Description of changes:
Docs updates for Baremetal configuration

Documentation added/planned (if applicable):

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@eks-distro-bot
Copy link
Collaborator

[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 mitalipaygude. 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

@eks-distro-bot eks-distro-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Oct 20, 2023
@codecov
Copy link

codecov bot commented Oct 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.01%. Comparing base (9193e87) to head (d436943).
Report is 630 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6860   +/-   ##
=======================================
  Coverage   72.01%   72.01%           
=======================================
  Files         532      532           
  Lines       41644    41644           
=======================================
  Hits        29991    29991           
  Misses       9980     9980           
  Partials     1673     1673           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@chrisnegus chrisnegus left a comment

Choose a reason for hiding this comment

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

Nice work. Just a few issues to address, I think.

@@ -91,6 +87,88 @@ spec:
- ssh-rsa AAAAB3NzaC1yc2... [email protected]
```

<pre>
Copy link
Member

Choose a reason for hiding this comment

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

This section is meant to replace what is still in lines 15-86, right? So I think you need to delete those lines.

controlPlaneConfiguration: <a href="#controlplaneconfiguration-required"># Specific cluster control plane config (required)</a>
count: <span style="color:green">2</span> <a href="#controlplaneconfigurationcount-required"># Number of control plane nodes (required)</a>
endpoint: <a href="#controlplaneconfigurationendpointhost-required"># IP for control plane endpoint (required)</a>
host: <span>"192.168.0.10"</span>
Copy link
Member

@chrisnegus chrisnegus Oct 31, 2023

Choose a reason for hiding this comment

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

The IP address here (192.168.0.10) is in the range handed out by clusterNetwork.pods.cidrBlocks earlier. The description in this field says not to set the IP address for the endpoint.host to an address that might be handed out by DHCP. You could either just do something generic like "Control Plane Endpoint IP" or use an address outside of that range.

name: my-cluster-datacenter
kubernetesVersion: <span>"1.28"</span> <a href="#kubernetesversion-required"># Kubernetes version to use for the cluster (required)</a>
workerNodeGroupConfigurations: <a href="#workernodegroupconfigurations"># List of node groups you can define for workers (required) </a>
- count: <span style="color:green">2</span> <a href="#workernodegroupconfigurationscount"># Number of worker nodes </a>
Copy link
Member

Choose a reason for hiding this comment

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

The count here is set to "2". The description says: "This number needs to be odd to maintain ETCD quorum."

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 you are referring the the cp configuration and not worker right? But yea even that is it at 2 right now without external etcd specified here.

apiVersion: anywhere.eks.amazonaws.com/v1alpha1
kind: TinkerbellDatacenterConfig
metadata:
name: my-cluster-datacenter
Copy link
Member

Choose a reason for hiding this comment

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

Check if you want this to say "my-cluster-datacenter". In previous versions, this was the same name as the cluster name, which was "my-cluster-name".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation documentation size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants