Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Jan 2, 2025
1 parent b69a0be commit 9270588
Show file tree
Hide file tree
Showing 22 changed files with 88 additions and 88 deletions.
6 changes: 3 additions & 3 deletions config/resources/access-grant.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ status:
description: |
@description@
- `Processed` - The controller has accepted the grant.
- `Resolved` - The grant service is available to process tokens
- `Processed`: The controller has accepted the grant.
- `Resolved`: The grant service is available to process tokens
for this grant.
- `Ready` - The grant is ready to use. All other
- `Ready`: The grant is ready to use. All other
conditions are true.
2 changes: 1 addition & 1 deletion config/resources/access-token.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ status:
description: |
@description@
- `Redeemed` - The token has been exchanged for a link.
- `Redeemed`: The token has been exchanged for a link.
6 changes: 3 additions & 3 deletions config/resources/link.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ status:
description: |
@description@
- `Configured` - The link configuration has been applied to
- `Configured`: The link configuration has been applied to
the router.
- `Operational` - The link to the remote site is active.
- `Ready` - The link is ready to use. All other conditions
- `Operational`: The link to the remote site is active.
- `Ready`: The link is ready to use. All other conditions
are true.
8 changes: 4 additions & 4 deletions config/resources/listener.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ spec:
description: |
@description@
- `observer` - Set the protocol observer used to generate
- `observer`: Set the protocol observer used to generate
traffic metrics.<br/>
Default: `auto`. Choices: `auto`, `none`, `http1`, `http2`.
status:
Expand All @@ -96,9 +96,9 @@ status:
description: |
@description@
- `Configured` - The listener configuration has been applied
- `Configured`: The listener configuration has been applied
to the router.
- `Matched` - There is at least one connector corresponding to
- `Matched`: There is at least one connector corresponding to
this listener.
- `Ready` - The listener is ready to use. All other conditions
- `Ready`: The listener is ready to use. All other conditions
are true.
12 changes: 6 additions & 6 deletions config/resources/properties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ status/status:
description: |
The current state of the resource.
- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.
status/message:
name: message
links: [skupper/resource_status]
Expand Down Expand Up @@ -153,9 +153,9 @@ connector/status/conditions:
A set of named conditions describing the current state of the
resource.
- `Configured` - The connector configuration has been applied
- `Configured`: The connector configuration has been applied
to the router.
- `Matched` - There is at least one listener corresponding to
- `Matched`: There is at least one listener corresponding to
this connector.
- `Ready` - The connector is ready to use. All other conditions
- `Ready`: The connector is ready to use. All other conditions
are true.
6 changes: 3 additions & 3 deletions config/resources/router-access.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ status:
description: |
@description@
- `Configured` - The router access configuration has been applied to
- `Configured`: The router access configuration has been applied to
the router.
- `Resolved` - The connection endpoints are available.
- `Ready` - The router access is ready to use. All other
- `Resolved`: The connection endpoints are available.
- `Ready`: The router access is ready to use. All other
conditions are true.
- name: endpoints
group: advanced
Expand Down
12 changes: 6 additions & 6 deletions config/resources/site.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,12 @@ spec:
description: |
@description@
- `routerDataConnections` - Set the number of data
- `routerDataConnections`: Set the number of data
connections the router uses when linking to other
routers.<br/>
Default: *Computed based on the number of router worker
threads. Minimum 2.*
- `routerLogging` - Set the router logging level.<br/>
- `routerLogging`: Set the router logging level.<br/>
Default: `info`. Choices: `info`, `warning`, `error`.
status:
include_properties: [status/*]
Expand All @@ -129,12 +129,12 @@ status:
description: |
@description@
- `Configured` - The output resources for this resource have
- `Configured`: The output resources for this resource have
been created.
- `Running` - There is at least one router pod running.
- `Resolved` - The hostname or IP address for link access is
- `Running`: There is at least one router pod running.
- `Resolved`: The hostname or IP address for link access is
available.
- `Ready` - The site is ready for use. All other conditions
- `Ready`: The site is ready for use. All other conditions
are true.
- name: defaultIssuer
group: advanced
Expand Down
4 changes: 2 additions & 2 deletions input/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
refdog_links:
- title: Command overview
url: overview.html
- title: Skupper concepts
- title: Concept index
url: /concepts/index.html
- title: Skupper resources
- title: Resource index
url: /resources/index.html
---

Expand Down
4 changes: 2 additions & 2 deletions input/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
refdog_links:
- title: Concept overview
url: overview.html
- title: Skupper resources
- title: Resource index
url: /resources/index.html
- title: Skupper commands
- title: Command index
url: /commands/index.html
---

Expand Down
12 changes: 6 additions & 6 deletions input/resources/access-grant.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,10 @@ their default values.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down Expand Up @@ -265,10 +265,10 @@ A set of named conditions describing the current state of the
resource.


- `Processed` - The controller has accepted the grant.
- `Resolved` - The grant service is available to process tokens
- `Processed`: The controller has accepted the grant.
- `Resolved`: The grant service is available to process tokens
for this grant.
- `Ready` - The grant is ready to use. All other
- `Ready`: The grant is ready to use. All other
conditions are true.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a>, <a href="https://maelvls.dev/kubernetes-conditions/">Kubernetes conditions</a></td></table>
Expand Down
8 changes: 4 additions & 4 deletions input/resources/access-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,10 @@ redeemed, it cannot be used again.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down Expand Up @@ -200,7 +200,7 @@ A set of named conditions describing the current state of the
resource.


- `Redeemed` - The token has been exchanged for a link.
- `Redeemed`: The token has been exchanged for a link.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a>, <a href="https://maelvls.dev/kubernetes-conditions/">Kubernetes conditions</a></td></table>

Expand Down
6 changes: 3 additions & 3 deletions input/resources/attached-connector-binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,10 @@ their default values.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down
6 changes: 3 additions & 3 deletions input/resources/attached-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,10 @@ their default values.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down
12 changes: 6 additions & 6 deletions input/resources/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,10 +259,10 @@ their default values.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down Expand Up @@ -310,11 +310,11 @@ key (usually in a remote site).
A set of named conditions describing the current state of the
resource.

- `Configured` - The connector configuration has been applied
- `Configured`: The connector configuration has been applied
to the router.
- `Matched` - There is at least one listener corresponding to
- `Matched`: There is at least one listener corresponding to
this connector.
- `Ready` - The connector is ready to use. All other conditions
- `Ready`: The connector is ready to use. All other conditions
are true.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
Expand Down
4 changes: 2 additions & 2 deletions input/resources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
refdog_links:
- title: Resource overview
url: overview.html
- title: Skupper concepts
- title: Concept index
url: /concepts/index.html
- title: Skupper commands
- title: Command index
url: /commands/index.html
---

Expand Down
12 changes: 6 additions & 6 deletions input/resources/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,10 @@ their default values.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down Expand Up @@ -211,10 +211,10 @@ A set of named conditions describing the current state of the
resource.


- `Configured` - The link configuration has been applied to
- `Configured`: The link configuration has been applied to
the router.
- `Operational` - The link to the remote site is active.
- `Ready` - The link is ready to use. All other conditions
- `Operational`: The link to the remote site is active.
- `Ready`: The link is ready to use. All other conditions
are true.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a>, <a href="https://maelvls.dev/kubernetes-conditions/">Kubernetes conditions</a></td></table>
Expand Down
14 changes: 7 additions & 7 deletions input/resources/listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ string name and a string value.
their default values.


- `observer` - Set the protocol observer used to generate
- `observer`: Set the protocol observer used to generate
traffic metrics.<br/>
Default: `auto`. Choices: `auto`, `none`, `http1`, `http2`.

Expand All @@ -197,10 +197,10 @@ their default values.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down Expand Up @@ -249,11 +249,11 @@ A set of named conditions describing the current state of the
resource.


- `Configured` - The listener configuration has been applied
- `Configured`: The listener configuration has been applied
to the router.
- `Matched` - There is at least one connector corresponding to
- `Matched`: There is at least one connector corresponding to
this listener.
- `Ready` - The listener is ready to use. All other conditions
- `Ready`: The listener is ready to use. All other conditions
are true.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a>, <a href="https://maelvls.dev/kubernetes-conditions/">Kubernetes conditions</a></td></table>
Expand Down
12 changes: 6 additions & 6 deletions input/resources/router-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,10 @@ their default values.

The current state of the resource.

- `Pending` - The resource is being processed.
- `Error` - There was an error processing the resource. See
- `Pending`: The resource is being processed.
- `Error`: There was an error processing the resource. See
`message` for more information.
- `Ready` - The resource is ready to use.
- `Ready`: The resource is ready to use.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a></td></table>

Expand Down Expand Up @@ -229,10 +229,10 @@ A set of named conditions describing the current state of the
resource.


- `Configured` - The router access configuration has been applied to
- `Configured`: The router access configuration has been applied to
the router.
- `Resolved` - The connection endpoints are available.
- `Ready` - The router access is ready to use. All other
- `Resolved`: The connection endpoints are available.
- `Ready`: The router access is ready to use. All other
conditions are true.

<table class="fields"><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="{{site_prefix}}/topics/resource-status.html">Resource status</a>, <a href="https://maelvls.dev/kubernetes-conditions/">Kubernetes conditions</a></td></table>
Expand Down
Loading

0 comments on commit 9270588

Please sign in to comment.