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-2075: Operator IP pool management docs #1390

Merged
merged 8 commits into from
Apr 5, 2024

Conversation

caseydavenport
Copy link
Member

@caseydavenport caseydavenport commented Mar 26, 2024

Product Version(s):

Calico v3.28 / Enterprise v3.19

Issue:

Link to docs preview:

SME review:

  • An SME has approved this change.

DOCS review:

  • A member of the docs team has approved this change.

Additional information:

Merge checklist:

  • Deploy preview inspected wherever changes were made
  • Build completed successfully
  • Test have passed

@caseydavenport caseydavenport requested a review from a team as a code owner March 26, 2024 21:44
Copy link

netlify bot commented Mar 26, 2024

Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit bb4e64e
🔍 Latest deploy log https://app.netlify.com/sites/calico-docs-preview-next/deploys/660eee4a415a8000089aa2a8
😎 Deploy Preview https://deploy-preview-1390--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 65 (🟢 up 6 from production)
Accessibility: 93 (no change from production)
Best Practices: 92 (no change from production)
SEO: 79 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Mar 26, 2024

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit bb4e64e
🔍 Latest deploy log https://app.netlify.com/sites/tigera/deploys/660eee4af51d830008677cfe
😎 Deploy Preview https://deploy-preview-1390--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 71 (🟢 up 24 from production)
Accessibility: 93 (no change from production)
Best Practices: 83 (no change from production)
SEO: 86 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@radTuti radTuti left a comment

Choose a reason for hiding this comment

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

lgtm

@ctauchen
Copy link
Collaborator

@caseydavenport You mentioned some other docs work we should consider for the multiple ip pools work. How to add ip pools, how to disable operator management of ip pools, considerations for upgrades. Are you planning to handle those separately, or has the scope changed?

@caseydavenport
Copy link
Member Author

I believe the considerations for upgrades are no longer necessary, as I have adjusted the way the feature behaves such that there are no extra steps required on upgrade.

How to add ip pools, how to disable operator management of ip pools

I think these are good to have and would like to add them to this PR (or a follow on). I am not sure the right place to put them though, so would be happy to hear any recommendations!

@ctauchen
Copy link
Collaborator

I believe the considerations for upgrades are no longer necessary, as I have adjusted the way the feature behaves such that there are no extra steps required on upgrade.

How to add ip pools, how to disable operator management of ip pools

I think these are good to have and would like to add them to this PR (or a follow on). I am not sure the right place to put them though, so would be happy to hear any recommendations!

I'd imagine this could work as a single page in here: https://docs.tigera.io/calico/latest/networking/ipam/.

Something along the lines of:

# Create multiple IP pools

## (Concept) Understanding multiple IP pools

Answers the questions: Who needs this? What's it good for?

## (Procedure) Create additional IP pools

## (Procedure) Prevent the operator from managing IP pools

@caseydavenport
Copy link
Member Author

@ctauchen I've pushed some new content to this PR that I'd like your eyes on :)

If it looks good, I think it should also be added to the unrelease enterprise documentation - should I simply copy the changes there?

@caseydavenport caseydavenport changed the title Remove IP pool limitation in operator API Operator IP pool management docs Apr 2, 2024
@caseydavenport
Copy link
Member Author

@ctauchen did you get a chance to take a look at this one?

Copy link
Collaborator

@ctauchen ctauchen left a comment

Choose a reason for hiding this comment

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

Some comments, mostly formatting with a few line edits. Let me take a final look after you make changes. When these are all good, we can get this all copied to /calico-enterprise/ to make it in for CE 3.19 EP2.

calico/networking/ipam/ippools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/ippools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/ippools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/ippools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/ippools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/migrate-pools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/migrate-pools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/migrate-pools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/migrate-pools.mdx Outdated Show resolved Hide resolved
calico/networking/ipam/migrate-pools.mdx Outdated Show resolved Hide resolved
@caseydavenport
Copy link
Member Author

@ctauchen thanks for the review! Think I got all of them now

@ctauchen
Copy link
Collaborator

ctauchen commented Apr 4, 2024

Thanks for the fixes @caseydavenport. You can update the same docs in ./calico-enterprise and we can get this merged. Thanks!

@caseydavenport
Copy link
Member Author

Thanks @ctauchen - updated enterprise as well.

@caseydavenport
Copy link
Member Author

@ctauchen shoot, looks like I overwrite the other fix commits. Hold off on reviewing again.

@caseydavenport
Copy link
Member Author

@ctauchen OK, I think it should be good to go now.

@ctauchen ctauchen changed the title Operator IP pool management docs DOCS-2075: Operator IP pool management docs Apr 5, 2024
@ctauchen
Copy link
Collaborator

ctauchen commented Apr 5, 2024

LGTM

@ctauchen ctauchen merged commit 867fcf7 into tigera:main Apr 5, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants