Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Dec 23, 2024
1 parent 891f40f commit b46b81e
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 11 deletions.
9 changes: 9 additions & 0 deletions config/resources/router-access.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ spec:
- name: generateTlsCredentials
- name: issuer
- name: accessType
platforms: [Kubernetes]
default: |
_On OpenShift, the default is `route`. For other
Kubernetes flavors, the default is `loadbalancer`._
choices:
- name: route
description: Use an OpenShift route. _OpenShift only._
- name: loadbalancer
description: Use a Kubernetes load balancer.
- name: bindHost
default: 0.0.0.0
platforms: [Docker, Podman, Linux]
Expand Down
12 changes: 7 additions & 5 deletions config/resources/site.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,15 @@ spec:
- name: none
description: No linking to this site is permitted.
- name: default
platforms: [Kubernetes]
description: |
Use the default link access for the current platform.
On OpenShift, the default is `route`. For other
Kubernetes flavors, the default is `loadbalancer`.
- name: route
description: Use an OpenShift route. _OpenShift only._
- name: loadbalancer
description: Use a Kubernetes load balancer. _Kubernetes only._
description: Use a Kubernetes load balancer.
- name: ha
updatable: true
platforms: [Kubernetes]
Expand All @@ -82,7 +83,7 @@ spec:
description: |
The name of a Kubernetes secret containing the signing CA
used to generate a certificate from a token. A secret is
generated if none is supplied.
generated if none is specified.
This issuer is used by AccessGrant and RouterAccess if a
specific issuer is not set.
Expand All @@ -105,12 +106,13 @@ spec:
router infrastructure. -->
- name: serviceAccount
group: advanced
default: skupper-router
default: _Generated_
platforms: [Kubernetes]
links: [kubernetes/service_accounts]
description: |
The name of the Kubernetes service account under which to
run the Skupper controller.
The name of the Kubernetes service account under which to run
the Skupper router. A service account is generated if none is
specified.
- name: settings
description: |
@description@
Expand Down
10 changes: 10 additions & 0 deletions input/resources/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Creation, updates, deletion
- Where do resources go in Kubernetes?
- Where do they go in non-Kube? FS location. system apply.
- You can use the CLI do these things.
- On Kubernetes, use kubectl apply and delete. On Docker, Podman, and
Linux, use skupper system apply and delete.

#### Common properties

Expand All @@ -49,10 +51,18 @@ Creation, updates, deletion
- **Listener:** {{lipsum(10)}}
- **Connector:** {{lipsum(10)}}

These are the main resources you interact with. The others are for
less common scenarios.

Site is the heart of things. The Site resource represents a location
in a Skupper network. It carries all the configuration for the site.
The starting point. The parent of other Skupper resources.

Links.... The Link resource is usually not created directly.
Instead, you use access tokens.

Listener and connector are the key resources for service exposure.

## Site linking resources

- **Link:** {{lipsum(10)}}
Expand Down
6 changes: 5 additions & 1 deletion input/resources/router-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,11 @@ directory under `input/certs/` in the current namespace.
</div>
<div class="attribute-body">

<table class="fields"><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td></table>
<table class="fields"><tr><th>Default</th><td><p><em>On OpenShift, the default is <code>route</code>. For other
Kubernetes flavors, the default is <code>loadbalancer</code>.</em></p>
</td><tr><th>Choices</th><td><table class="choices"><tr><th><code>route</code></th><td><p>Use an OpenShift route. <em>OpenShift only.</em></p>
</td></tr><tr><th><code>loadbalancer</code></th><td><p>Use a Kubernetes load balancer.</p>
</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes</td></table>

</div>
</div>
Expand Down
11 changes: 6 additions & 5 deletions input/resources/site.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ the sites must have link access enabled.
</td><tr><th>Choices</th><td><table class="choices"><tr><th><code>none</code></th><td><p>No linking to this site is permitted.</p>
</td></tr><tr><th><code>default</code></th><td><p>Use the default link access for the current platform. On OpenShift, the default is <code>route</code>. For other Kubernetes flavors, the default is <code>loadbalancer</code>.</p>
</td></tr><tr><th><code>route</code></th><td><p>Use an OpenShift route. <em>OpenShift only.</em></p>
</td></tr><tr><th><code>loadbalancer</code></th><td><p>Use a Kubernetes load balancer. <em>Kubernetes only.</em></p>
</td></tr><tr><th><code>loadbalancer</code></th><td><p>Use a Kubernetes load balancer.</p>
</td></tr></table></td><tr><th>Platforms</th><td>Kubernetes, Docker, Podman, Linux</td><tr><th>Updatable</th><td>True</td><tr><th>See also</th><td><a href="{{site_prefix}}/concepts/link.html">Link concept</a>, <a href="{{site_prefix}}/topics/site-linking.html">Site linking</a></td></table>

</div>
Expand Down Expand Up @@ -168,7 +168,7 @@ window of downtime caused by restarts.

The name of a Kubernetes secret containing the signing CA
used to generate a certificate from a token. A secret is
generated if none is supplied.
generated if none is specified.

This issuer is used by AccessGrant and RouterAccess if a
specific issuer is not set.
Expand Down Expand Up @@ -213,10 +213,11 @@ router infrastructure. -->
</div>
<div class="attribute-body">

The name of the Kubernetes service account under which to
run the Skupper controller.
The name of the Kubernetes service account under which to run
the Skupper router. A service account is generated if none is
specified.

<table class="fields"><tr><th>Default</th><td><p><code>skupper-router</code></p>
<table class="fields"><tr><th>Default</th><td><p><em>Generated</em></p>
</td><tr><th>Platforms</th><td>Kubernetes</td><tr><th>See also</th><td><a href="https://kubernetes.io/docs/concepts/security/service-accounts/">Kubernetes service accounts</a></td></table>

</div>
Expand Down

0 comments on commit b46b81e

Please sign in to comment.