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 usage docs for IPAM resources #1221

Merged
merged 3 commits into from
Feb 4, 2025
Merged

Add usage docs for IPAM resources #1221

merged 3 commits into from
Feb 4, 2025

Conversation

ushabelgur
Copy link
Contributor

Proposed Changes

  • Add usage documentation for Prefix in ipam section
  • Sample example yaml to create each of the resources with keyFields explained
  • Reconciliation logic explained
  • Fix lint issue in proposal docs

Fixes #1193

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request size/L labels Jan 21, 2025
@ushabelgur ushabelgur marked this pull request as ready for review January 21, 2025 07:23
@ushabelgur ushabelgur requested a review from a team as a code owner January 21, 2025 07:23
@afritzler afritzler changed the title Osc/enh/doc ipam core Add usage docs for IPAM resources Jan 29, 2025
afritzler
afritzler reviewed Jan 29, 2025
View reviewed changes
Copy link
Member

@afritzler afritzler left a comment

Choose a reason for hiding this comment

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

Can we remove the "" from the proposal files. I guess that was some IDE autocorrection.

@ushabelgur
Copy link
Contributor Author

Can we remove the "" from the proposal files. I guess that was some IDE autocorrection.

I added to it remove this yaml error from all the proposal files
image

afritzler
afritzler requested changes Jan 29, 2025
View reviewed changes
@lukas016 lukas016 force-pushed the osc/enh/doc_ipam_core branch from 4501899 to 7a5ada3 Compare January 29, 2025 09:25
@afritzler afritzler merged commit 8297a47 into ironcore-dev:main Feb 4, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afritzler afritzler afritzler approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request size/L
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document ipam API group
2 participants
@ushabelgur @afritzler