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

DOCS-2240: Removes supported operations table from resources. #1832

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOCS-2240: Removes supported operations table from resources. #1832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions calico/reference/resources/bgpconfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,4 @@ spec:
| Field | Description | Accepted Values | Schema |
| ----------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| cidr | CIDR for which properties should be advertised. | `cidr: XXX.XXX.XXX.XXX/XX` | string |
| communities | BGP communities to be advertised. | Communities can be list of either community names already defined in [communities](#communities) or community value of format `aa:nn` or `aa:nn:mm`. <br/>For standard community, value should be in `aa:nn` format, where both `aa` and `nn` are 16 bit integers.<br/> For large community, value should be `aa:nn:mm` format, where `aa`, `nn` and `mm` are all 32 bit integers. <br/>Where `aa` is an AS Number, `nn` and `mm` are per-AS identifier. | List of string |

## Supported operations

| Datastore type | Create | Delete | Delete (Global `default`) | Update | Get/List | Notes |
| --------------------- | ------ | ------ | ------------------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | No | Yes | Yes |
| Kubernetes API server | Yes | Yes | No | Yes | Yes |
| communities | BGP communities to be advertised. | Communities can be list of either community names already defined in [communities](#communities) or community value of format `aa:nn` or `aa:nn:mm`. <br/>For standard community, value should be in `aa:nn` format, where both `aa` and `nn` are 16 bit integers.<br/> For large community, value should be `aa:nn:mm` format, where `aa`, `nn` and `mm` are all 32 bit integers. <br/>Where `aa` is an AS Number, `nn` and `mm` are per-AS identifier. | List of string |
8 changes: 1 addition & 7 deletions calico/reference/resources/bgpfilter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,4 @@ spec:
| Field | Description | Accepted Values | Schema | Default |
| ------ | --------------------------------------------- | ------------------------------------------------------------------- | ------ | ------- |
| min | Smallest matched mask size (0 by default) | Valid integers between 0 and ipv4/6 max (32, 128) | int | |
| max | Largest matched mask size (32/128 by default) | Valid integers between 1 and ipv4/6 max (32, 128) | int | |

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| --------------------- | ------------- | ------ | -------- | ----- |
| Kubernetes API server | Yes | Yes | Yes | |
| max | Largest matched mask size (32/128 by default) | Valid integers between 1 and ipv4/6 max (32, 128) | int | |
7 changes: 0 additions & 7 deletions calico/reference/resources/bgppeer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,6 @@ A BGP peer can also be node-specific. When the `node` field is included, only th
will peer with it. When the `nodeSelector` field is included, the nodes with labels that match that selector
will peer with it.

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| --------------------- | ------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API server | Yes | Yes | Yes |

## Selectors

<Selectors />
Expand Down
9 changes: 1 addition & 8 deletions calico/reference/resources/blockaffinity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,4 @@
| state | State of the affinity with regard to any referenced IPAM blocks. | confirmed, pending, pendingDeletion | string | |
| node | The node that this affinity is assigned to. | The hostname of the node | string | |
| cidr | The CIDR range this block affinity references. | A valid IPv4 or IPv6 CIDR. | string | |
| deleted | When set to true, clients should treat this block as if it does not exist. | true, false | boolean | `false` |

## Supported operations

| Datastore type | Create | Delete | Update | Get/List | Watch |
| --------------------- | ------ | ------ | ------ | -------- | ----- |
| etcdv3 | No | No | No | Yes | Yes |
| Kubernetes API server | No | No | No | Yes | Yes |
| deleted | When set to true, clients should treat this block as if it does not exist. | true, false | boolean | `false` |

Check failure on line 24 in calico/reference/resources/blockaffinity.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'boolean'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'boolean'?", "location": {"path": "calico/reference/resources/blockaffinity.mdx", "range": {"start": {"line": 24, "column": 128}}}, "severity": "ERROR"}
9 changes: 1 addition & 8 deletions calico/reference/resources/felixconfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,4 @@ Setting `awsSrcDstCheck` to `Disable` will automatically disable source-destinat

If there are no policies attached to node roles containing the above statement, attach a new policy. For example, if a node role is `test-cluster-nodeinstance-role`, click on the IAM role in AWS console. In the `Permission policies` list, add a new inline policy with the above statement to the new policy JSON definition. For detailed information, see [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html?icmpid=docs_iam_console).

For an EKS cluster, the necessary IAM role and policy is available by default. No further actions are needed.

## Supported operations

| Datastore type | Create | Delete | Delete (Global `default`) | Update | Get/List | Notes |
| --------------------- | ------ | ------ | ------------------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | No | Yes | Yes | |
| Kubernetes API server | Yes | Yes | No | Yes | Yes | |
For an EKS cluster, the necessary IAM role and policy is available by default. No further actions are needed.
9 changes: 1 addition & 8 deletions calico/reference/resources/globalnetworkpolicy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,11 +170,4 @@ Application layer policy match criteria are supported with the following restric

### HTTPMatch

<Httpmatch />

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| ------------------------ | ------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API datastore | Yes | Yes | Yes |
<Httpmatch />
9 changes: 1 addition & 8 deletions calico/reference/resources/hostendpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,4 @@ spec:

### EndpointPort

<Endpointport />

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| --------------------- | ------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API server | Yes | Yes | Yes |
<Endpointport />
9 changes: 1 addition & 8 deletions calico/reference/resources/ipamconfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,4 @@ The resource is a singleton which must have the name `default`.
| Field | Description | Accepted Values | Schema | Default |
| ---------------- | ------------------------------------------------------------------- | --------------- | ------ | --------- |
| strictAffinity | When StrictAffinity is true, borrowing IP addresses is not allowed. | true, false | bool | false |
| maxBlocksPerHost | The max number of blocks that can be affine to each host. | 0 - max(int32) | int | 20 |

## Supported operations

| Datastore type | Create | Delete | Update | Get/List |
| --------------------- | ------ | ------ | ------ | -------- |
| etcdv3 | Yes | Yes | Yes | Yes |
| Kubernetes API server | Yes | Yes | Yes | Yes |
| maxBlocksPerHost | The max number of blocks that can be affine to each host. | 0 - max(int32) | int | 20 |
7 changes: 0 additions & 7 deletions calico/reference/resources/ippool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,6 @@ used for manual assignments.

<Selectors />

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| --------------------- | ------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API server | Yes | Yes | Yes |

## See also

The [`IPReservation` resource](ipreservation.mdx) allows for small parts of an IP pool to be reserved so that they will
Expand Down
7 changes: 0 additions & 7 deletions calico/reference/resources/kubecontrollersconfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,4 @@ $[prodname] datastore.
| ---------------- | ---------------------------------------------------------------- | --------------------------------- | ------- |
| reconcilerPeriod | Period to perform reconciliation with the $[prodname] datastore | [Duration string][parse-duration] | 5m |

## Supported operations

| Datastore type | Create | Delete (Global `default`) | Update | Get/List | Notes |
| --------------------- | ------ | ------------------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | Yes | Yes |
| Kubernetes API server | Yes | Yes | Yes | Yes |

[parse-duration]: https://golang.org/pkg/time/#ParseDuration
9 changes: 1 addition & 8 deletions calico/reference/resources/networkpolicy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,4 @@ Application layer policy match criteria are supported with the following restric

### HTTPMatch

<Httpmatch />

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| ------------------------ | ------------- | ------ | -------- | ----- |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API datastore | Yes | Yes | Yes |
<Httpmatch />
9 changes: 1 addition & 8 deletions calico/reference/resources/node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,4 @@ spec:
| Field | Description | Accepted Values | Schema | Default |
| -------------------- | ----------------------------------------------------------------------------------------- | --------------- | ------ | ------- |
| interfaceIPv4Address | The IP address and subnet for the IPv4 WireGuard interface created by Felix on this node. | Optional | string |
| interfaceIPv6Address | The IP address and subnet for the IPv6 WireGuard interface created by Felix on this node. | Optional | string |

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| --------------------- | ------------- | ------ | -------- | ------------------------------------------------------------------ |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API server | No | Yes | Yes | `$[nodecontainer]` data is directly tied to the Kubernetes nodes. |
| interfaceIPv6Address | The IP address and subnet for the IPv6 WireGuard interface created by Felix on this node. | Optional | string |
9 changes: 1 addition & 8 deletions calico/reference/resources/profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,4 @@ spec:
| labelsToApply | An optional set of labels to apply to each endpoint in this profile (in addition to the endpoint's own labels) | | map |

For `Rule` details please see the [NetworkPolicy](networkpolicy.mdx) or
[GlobalNetworkPolicy](globalnetworkpolicy.mdx) resource.

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| --------------------- | ------------- | ------ | -------- | ------------------------------------------------------------------------------ |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API server | No | No | Yes | $[prodname] profiles are pre-assigned for each Namespace and Service Account. |
[GlobalNetworkPolicy](globalnetworkpolicy.mdx) resource.
9 changes: 1 addition & 8 deletions calico/reference/resources/workloadendpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,4 @@ They only have an effect if they are referred to in policy.
The hostPort and hostIP fields are read-only and determined from Kubernetes hostPort configuration.
These fields are used only when host ports are enabled in Calico.

:::

## Supported operations

| Datastore type | Create/Delete | Update | Get/List | Notes |
| --------------------- | ------------- | ------ | -------- | -------------------------------------------------------- |
| etcdv3 | Yes | Yes | Yes |
| Kubernetes API server | No | Yes | Yes | WorkloadEndpoints are directly tied to a Kubernetes pod. |
:::
Loading