Repository navigation
Conversation
✅ Deploy Preview for calico-docs-preview-next ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
🟡 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
| | 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 | | |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
| | 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 | | |
There was a problem hiding this comment.
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!
| | 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 | | |
There was a problem hiding this comment.
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!
| | 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 | | |
There was a problem hiding this comment.
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!


Adds a reference page for the ClusterInformation resource to Calico Open Source next, 3.33, 3.32, and 3.31.
Jira: https://tigera.atlassian.net/browse/DOCS-3102
Previews: