Skip to content

Commit 4a7d502

Browse files
robbrockbankrobbrockbank
authored
Merge pull request #965 from robbrockbank/kdd-valid-resources
Add table describing per-datastore availability
2 parents 3530d67 + 81d34aa commit 4a7d502

24 files changed

+144
-0
lines changed

‎master/reference/calicoctl/commands/apply.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl apply` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl apply' command
1115

1216
Run `calicoctl apply --help` to display the following help menu for the

‎master/reference/calicoctl/commands/create.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl create` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl create' command
1115

1216
Run `calicoctl create --help` to display the following help menu for the

‎master/reference/calicoctl/commands/delete.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl delete` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl delete' command
1115

1216
Run `calicoctl delete --help` to display the following help menu for the

‎master/reference/calicoctl/commands/get.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl get` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl get' command
1115

1216
Run `calicoctl get --help` to display the following help menu for the

‎master/reference/calicoctl/commands/replace.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl replace` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl replace' command
1115

1216
Run `calicoctl replace --help` to display the following help menu for the

‎master/reference/calicoctl/resources/bgppeer.md

+6
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,9 @@ A BGP peer can also be added at the `node` scope, meaning only a single specifie
5656
node will peer with it. BGP peer resources of this nature must specify a `node`
5757
to inform Calico which node this peer is targeting.
5858

59+
### Supported operations
60+
61+
| Datastore type | Create/Delete | Update | Get/List | Notes
62+
+-----------------------+---------------+--------+----------+------
63+
| etcdv2 | Yes | Yes | Yes |
64+
| Kubernetes API server | Yes | Yes | Yes |

‎master/reference/calicoctl/resources/hostendpoint.md

+7
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,10 @@ spec:
5050
| interfaceName | The name of the interface on which to apply policy. | | string |
5151
| expectedIPs | The expected IP addresses associated with the interface. | Valid IPv4 or IPv6 address | list |
5252
| profiles | The list of profiles to apply to the endpoint. | | list |
53+
54+
### Supported operations
55+
56+
| Datastore type | Create/Delete | Update | Get/List | Notes
57+
+-----------------------+---------------+--------+----------+------
58+
| etcdv2 | Yes | Yes | Yes |
59+
| Kubernetes API server | No | No | No |

‎master/reference/calicoctl/resources/ippool.md

+8
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,11 @@ For details on configuring IP-in-IP on your deployment, please read the
6161
When `ipip` is enabled without `nat-outgoing` routing between Workloads and
6262
Hosts running Calico is asymmetric and may cause traffic to be filtered due to
6363
[RPF](https://en.wikipedia.org/wiki/Reverse_path_forwarding) checks failing.
64+
65+
66+
### Supported operations
67+
68+
| Datastore type | Create/Delete | Update | Get/List | Notes
69+
+-----------------------+---------------+--------+----------+------
70+
| etcdv2 | Yes | Yes | Yes |
71+
| Kubernetes API server | Yes | Yes | Yes |

‎master/reference/calicoctl/resources/node.md

+7
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,10 @@ spec:
5050
| asNumber | The AS Number of your Calico node. | Optional. If omitted the global value is used (see [calicoctl config]({{site.baseurl}}/{{page.version}}/reference/calicoctl/commands/config) for details). | integer |
5151
| ipv4Address | The IPv4 address and subnet exported as the next-hop for the Calico endpoints on the host | The IPv4 address must be specified if BGP is enabled. | string |
5252
| ipv6Address | The IPv6 address and subnet exported as the next-hop for the Calico endpoints on the host | Optional. | string |
53+
54+
### Supported operations
55+
56+
| Datastore type | Create/Delete | Update | Get/List | Notes
57+
+-----------------------+---------------+--------+----------+------
58+
| etcdv2 | Yes | Yes | Yes |
59+
| Kubernetes API server | No | Yes | Yes | Calico Node data is directly tied to the Kubernetes nodes.

‎master/reference/calicoctl/resources/policy.md

+8
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,11 @@ applied action is deny.
111111
#### Ports
112112

113113
{% include {{page.version}}/ports.md %}
114+
115+
116+
### Supported operations
117+
118+
| Datastore type | Create/Delete | Update | Get/List | Notes
119+
+-----------------------+---------------+--------+----------+------
120+
| etcdv2 | Yes | Yes | Yes |
121+
| Kubernetes API server | No | No | Yes | Policy is determined from Kubernetes NetworkPolicy resources.

‎master/reference/calicoctl/resources/profile.md

+8
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,11 @@ spec:
9797
#### Ports
9898
9999
{% include {{page.version}}/ports.md %}
100+
101+
102+
### Supported operations
103+
104+
| Datastore type | Create/Delete | Update | Get/List | Notes
105+
+-----------------------+---------------+--------+----------+------
106+
| etcdv2 | Yes | Yes | Yes |
107+
| Kubernetes API server | No | No | Yes | Calico profiles are pre-assigned for each Namespace.

‎master/reference/calicoctl/resources/workloadendpoint.md

+8
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,11 @@ spec:
6161
| profiles | List of profiles assigned to this endpoint. | | List of strings |
6262
| interfaceName | The name of the host-side interface attached to the workload. | | string |
6363
| mac | The source MAC address of traffic generated by the workload. | | IEEE 802 MAC-48, EUI-48, or EUI-64 |
64+
65+
66+
### Supported operations
67+
68+
| Datastore type | Create/Delete | Update | Get/List | Notes
69+
+-----------------------+---------------+--------+----------+------
70+
| etcdv2 | Yes | Yes | Yes |
71+
| Kubernetes API server | No | Yes | Yes | WorkloadEndpoints are directly tied to a Kuberenetes Pod.

‎v2.4/reference/calicoctl/commands/apply.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl apply` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl apply' command
1115

1216
Run `calicoctl apply --help` to display the following help menu for the

‎v2.4/reference/calicoctl/commands/create.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl create` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl create' command
1115

1216
Run `calicoctl create --help` to display the following help menu for the

‎v2.4/reference/calicoctl/commands/delete.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl delete` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl delete' command
1115

1216
Run `calicoctl delete --help` to display the following help menu for the

‎v2.4/reference/calicoctl/commands/get.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl get` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl get' command
1115

1216
Run `calicoctl get --help` to display the following help menu for the

‎v2.4/reference/calicoctl/commands/replace.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This sections describes the `calicoctl replace` command.
77
Read the [calicoctl command line interface user reference]({{site.baseurl}}/{{page.version}}/reference/calicoctl/)
88
for a full list of calicoctl commands.
99

10+
> The available actions for a specific resource type may be limited based on the datastore
11+
> used for Calico (etcdv2 / Kubernetes API). Please refer to the [Resources section]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/)
12+
> for details about each resource type.
13+
1014
## Displaying the help text for 'calicoctl replace' command
1115

1216
Run `calicoctl replace --help` to display the following help menu for the

‎v2.4/reference/calicoctl/resources/bgppeer.md

+6
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,9 @@ A BGP peer can also be added at the `node` scope, meaning only a single specifie
5656
node will peer with it. BGP peer resources of this nature must specify a `node`
5757
to inform Calico which node this peer is targeting.
5858

59+
### Supported operations
60+
61+
| Datastore type | Create/Delete | Update | Get/List | Notes
62+
+-----------------------+---------------+--------+----------+------
63+
| etcdv2 | Yes | Yes | Yes |
64+
| Kubernetes API server | Yes | Yes | Yes |

‎v2.4/reference/calicoctl/resources/hostendpoint.md

+7
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,10 @@ spec:
5050
| interfaceName | The name of the interface on which to apply policy. | | string |
5151
| expectedIPs | The expected IP addresses associated with the interface. | Valid IPv4 or IPv6 address | list |
5252
| profiles | The list of profiles to apply to the endpoint. | | list |
53+
54+
### Supported operations
55+
56+
| Datastore type | Create/Delete | Update | Get/List | Notes
57+
+-----------------------+---------------+--------+----------+------
58+
| etcdv2 | Yes | Yes | Yes |
59+
| Kubernetes API server | No | No | No |

‎v2.4/reference/calicoctl/resources/ippool.md

+8
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,11 @@ For details on configuring IP-in-IP on your deployment, please read the
6161
When `ipip` is enabled without `nat-outgoing` routing between Workloads and
6262
Hosts running Calico is asymmetric and may cause traffic to be filtered due to
6363
[RPF](https://en.wikipedia.org/wiki/Reverse_path_forwarding) checks failing.
64+
65+
66+
### Supported operations
67+
68+
| Datastore type | Create/Delete | Update | Get/List | Notes
69+
+-----------------------+---------------+--------+----------+------
70+
| etcdv2 | Yes | Yes | Yes |
71+
| Kubernetes API server | Yes | Yes | Yes |

‎v2.4/reference/calicoctl/resources/node.md

+7
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,10 @@ spec:
5050
| asNumber | The AS Number of your Calico node. | Optional. If omitted the global value is used (see [calicoctl config]({{site.baseurl}}/{{page.version}}/reference/calicoctl/commands/config) for details). | integer |
5151
| ipv4Address | The IPv4 address and subnet exported as the next-hop for the Calico endpoints on the host | The IPv4 address must be specified if BGP is enabled. | string |
5252
| ipv6Address | The IPv6 address and subnet exported as the next-hop for the Calico endpoints on the host | Optional. | string |
53+
54+
### Supported operations
55+
56+
| Datastore type | Create/Delete | Update | Get/List | Notes
57+
+-----------------------+---------------+--------+----------+------
58+
| etcdv2 | Yes | Yes | Yes |
59+
| Kubernetes API server | No | Yes | Yes | Calico Node data is directly tied to the Kubernetes nodes.

‎v2.4/reference/calicoctl/resources/policy.md

+8
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,11 @@ applied action is deny.
111111
#### Ports
112112

113113
{% include {{page.version}}/ports.md %}
114+
115+
116+
### Supported operations
117+
118+
| Datastore type | Create/Delete | Update | Get/List | Notes
119+
+-----------------------+---------------+--------+----------+------
120+
| etcdv2 | Yes | Yes | Yes |
121+
| Kubernetes API server | No | No | Yes | Policy is determined from Kubernetes NetworkPolicy resources.

‎v2.4/reference/calicoctl/resources/profile.md

+8
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,11 @@ spec:
9797
#### Ports
9898
9999
{% include {{page.version}}/ports.md %}
100+
101+
102+
### Supported operations
103+
104+
| Datastore type | Create/Delete | Update | Get/List | Notes
105+
+-----------------------+---------------+--------+----------+------
106+
| etcdv2 | Yes | Yes | Yes |
107+
| Kubernetes API server | No | No | Yes | Calico profiles are pre-assigned for each Namespace.

‎v2.4/reference/calicoctl/resources/workloadendpoint.md

+8
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,11 @@ spec:
6161
| profiles | List of profiles assigned to this endpoint. | | List of strings |
6262
| interfaceName | The name of the host-side interface attached to the workload. | | string |
6363
| mac | The source MAC address of traffic generated by the workload. | | IEEE 802 MAC-48, EUI-48, or EUI-64 |
64+
65+
66+
### Supported operations
67+
68+
| Datastore type | Create/Delete | Update | Get/List | Notes
69+
+-----------------------+---------------+--------+----------+------
70+
| etcdv2 | Yes | Yes | Yes |
71+
| Kubernetes API server | No | Yes | Yes | WorkloadEndpoints are directly tied to a Kuberenetes Pod.

0 commit comments

Comments
 (0)