Skip to content

DOCS-3102: Add the cluster information resource reference - #3225

Open
ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3102-clusterinformation
Open

ctauchen wants to merge 2 commits into
tigera:mainfrom
ctauchen:DOCS-3102-clusterinformation

Conversation

Copilot AI lite review requested due to automatic review settings November 16, 2026 19:32
@netlify

netlify Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

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

Built without sensitive environment variables

Name Link
🔨 Latest commit bd694fc
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6afc991428a8cc8b539d50f1
😎 Deploy Preview https://deploy-preview-3225--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@netlify

netlify Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit bd694fc
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6afc9914f0f708cfb858194f
😎 Deploy Preview https://deploy-preview-3225--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: 86 (🟢 up 15 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The ClusterInformationSpec reference omits the schema-defined cnxVersion field in four documentation files, leaving the field-level API documentation incomplete.

4 open issues
What changed in this PR

Adds ClusterInformation resource reference documentation for Calico Open Source's next documentation tree and versions 3.31–3.33, including resource details, navigation, and overview links.

Changes:

  • Adds ClusterInformation reference pages for the current and versioned documentation.
  • Documents resource metadata, specification fields, aliases, access requirements, and related commands.
  • Adds the resource to each corresponding sidebar and resource overview.
File Description
sidebars-calico.js Adds the ClusterInformation reference page to the current Calico resource sidebar.
calico/​reference/​resources/​overview.mdx Links to ClusterInformation from the current resource overview.
calico/​reference/​resources/​clusterinformation.mdx Adds the current ClusterInformation resource reference page.
calico_versioned_sidebars/​version-3.33-sidebars.json Adds the ClusterInformation reference page to the Calico 3.33 sidebar.
calico_versioned_sidebars/​version-3.32-sidebars.json Adds the ClusterInformation reference page to the Calico 3.32 sidebar.
calico_versioned_sidebars/​version-3.31-sidebars.json Adds the ClusterInformation reference page to the Calico 3.31 sidebar.
calico_versioned_docs/​version-3.33/​reference/​resources/​overview.mdx Links to ClusterInformation from the 3.33 resource overview.
calico_versioned_docs/​version-3.33/​reference/​resources/​clusterinformation.mdx Adds the 3.33 ClusterInformation resource reference page.
calico_versioned_docs/​version-3.32/​reference/​resources/​overview.mdx Links to ClusterInformation from the 3.32 resource overview.
calico_versioned_docs/​version-3.32/​reference/​resources/​clusterinformation.mdx Adds the 3.32 ClusterInformation resource reference page.
calico_versioned_docs/​version-3.31/​reference/​resources/​overview.mdx Links to ClusterInformation from the 3.31 resource overview.
calico_versioned_docs/​version-3.31/​reference/​resources/​clusterinformation.mdx Adds the 3.31 ClusterInformation resource reference page.

Review effort: Lite

Comment on lines +41 to +42
| calicoVersion | The version of $[prodname] that the cluster runs, such as `v3.33.1`. | | string | |
| datastoreReady | Whether the datastore is ready for use. In API server mode, the [`calicoctl datastore migrate lock`](../calicoctl/datastore/migrate/lock.mdx) command sets this field to `false`, and the [`calicoctl datastore migrate unlock`](../calicoctl/datastore/migrate/unlock.mdx) command sets it to `true`. | `true`, `false` | boolean | |

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Check this. I expect this is a CE thing, not relevant to OSS. But people might wonder. In that case, perhaps best to include and explain what it is.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

cnxVersion is not in the Calico Open Source API.
On kind clusters at v3.33.1 and v3.32.4, kubectl explain shows no such field, and the API rejects it as an unknown field.
A v3.31.7 cluster serves the same five fields.

The field comes from static/json/calico-api-swagger.json, which is the REST API for Calico Enterprise and Calico Cloud.

In bd694fc I added two sentences under the Spec table. They say Calico Enterprise has this field and Calico Open Source doesn't.

PTAL @caseydavenport, and thanks!

Comment on lines +41 to +42
| calicoVersion | The version of $[prodname] that the cluster runs, such as `v3.31.7`. | | string | |
| datastoreReady | Whether the datastore is ready for use. The [`calicoctl datastore migrate lock`](../calicoctl/datastore/migrate/lock.mdx) command sets this field to `false`, and the [`calicoctl datastore migrate unlock`](../calicoctl/datastore/migrate/unlock.mdx) command sets it to `true`. | `true`, `false` | boolean | |

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

cnxVersion is not in the Calico Open Source API.
On kind clusters at v3.33.1 and v3.32.4, kubectl explain shows no such field, and the API rejects it as an unknown field.
A v3.31.7 cluster serves the same five fields.

The field comes from static/json/calico-api-swagger.json, which is the REST API for Calico Enterprise and Calico Cloud.

In bd694fc I added two sentences under the Spec table. They say Calico Enterprise has this field and Calico Open Source doesn't.

PTAL @caseydavenport, and thanks!

Comment on lines +41 to +42
| calicoVersion | The version of $[prodname] that the cluster runs, such as `v3.32.4`. | | string | |
| datastoreReady | Whether the datastore is ready for use. In API server mode, the [`calicoctl datastore migrate lock`](../calicoctl/datastore/migrate/lock.mdx) command sets this field to `false`, and the [`calicoctl datastore migrate unlock`](../calicoctl/datastore/migrate/unlock.mdx) command sets it to `true`. | `true`, `false` | boolean | |

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

cnxVersion is not in the Calico Open Source API.
On kind clusters at v3.33.1 and v3.32.4, kubectl explain shows no such field, and the API rejects it as an unknown field.
A v3.31.7 cluster serves the same five fields.

The field comes from static/json/calico-api-swagger.json, which is the REST API for Calico Enterprise and Calico Cloud.

In bd694fc I added two sentences under the Spec table. They say Calico Enterprise has this field and Calico Open Source doesn't.

PTAL @caseydavenport, and thanks!

Comment on lines +41 to +42
| calicoVersion | The version of $[prodname] that the cluster runs, such as `v3.33.1`. | | string | |
| datastoreReady | Whether the datastore is ready for use. In API server mode, the [`calicoctl datastore migrate lock`](../calicoctl/datastore/migrate/lock.mdx) command sets this field to `false`, and the [`calicoctl datastore migrate unlock`](../calicoctl/datastore/migrate/unlock.mdx) command sets it to `true`. | `true`, `false` | boolean | |

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

cnxVersion is not in the Calico Open Source API.
On kind clusters at v3.33.1 and v3.32.4, kubectl explain shows no such field, and the API rejects it as an unknown field.
A v3.31.7 cluster serves the same five fields.

The field comes from static/json/calico-api-swagger.json, which is the REST API for Calico Enterprise and Calico Cloud.

In bd694fc I added two sentences under the Spec table. They say Calico Enterprise has this field and Calico Open Source doesn't.

PTAL @caseydavenport, and thanks!

@ctauchen
ctauchen marked this pull request as ready for review November 17, 2026 14:40
@ctauchen
ctauchen requested a review from a team as a code owner November 17, 2026 14:40
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.

2 participants