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

Add documentation for using a custom CNI #5408

Merged
merged 1 commit into from
Mar 30, 2023
Merged

Add documentation for using a custom CNI #5408

merged 1 commit into from
Mar 30, 2023

Conversation

chrisdoherty4
Copy link
Contributor

Issue #, if available: #5217

Description of changes:

Add documentation for using custom CNIs.

@eks-distro-bot
Copy link
Collaborator

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@eks-distro-bot eks-distro-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 27, 2023
@chrisdoherty4 chrisdoherty4 marked this pull request as ready for review March 27, 2023 19:41
@codecov
Copy link

codecov bot commented Mar 27, 2023

Codecov Report

Merging #5408 (0a47c53) into main (1182220) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #5408   +/-   ##
=======================================
  Coverage   72.71%   72.71%           
=======================================
  Files         442      442           
  Lines       36739    36737    -2     
=======================================
  Hits        26713    26713           
+ Misses       8426     8424    -2     
  Partials     1600     1600           

see 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.


{{% alert title="Warning" color="warning" %}}
Clusters created using the Full Lifecycle Controller prior to v0.15 that have removed the EKS-A
Cilium CNI must manually populate their `Cluster` object with the following annotation to ensure
Copy link
Member

Choose a reason for hiding this comment

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

How do they manually do this? via kubectl -f apply with an updated cluster spec?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's multiple ways to do it. Do we need to prescribe how? We could be clearer about the object they're editing though given there are multiple Cluster objects.

Copy link
Member

Choose a reason for hiding this comment

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

This sentence may not be clear to newer users. I'm assuming the annotation goes on the Cluster spec and I apply that via my choice of K8s API conformant tool (GitOps, Terraform, kubectl, etc.).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made clear its a cluster spec object and the exact object that needs annotating.

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.

In our docs, we try to avoid "EKS-A" and use the formal name "EKS Anywhere". Otherwise, the content looks good to me.

@chrisnegus
Copy link
Member

/lgtm
/approve

@eks-distro-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chrisnegus

The full list of commands accepted by this bot can be found here.

The pull request process is described 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

@chrisnegus
Copy link
Member

/cherrypick release-0.15

@eks-distro-pr-bot
Copy link
Contributor

@chrisnegus: once the present PR merges, I will cherry-pick it on top of release-0.15 in a new PR and assign it to you.

In response to this:

/cherrypick release-0.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@eks-distro-pr-bot
Copy link
Contributor

@chrisnegus: new pull request created: #5469

In response to this:

/cherrypick release-0.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

ddjjia pushed a commit to ddjjia/eks-anywhere that referenced this pull request Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/docs Documentation documentation lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants