Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Jan 14, 2025
1 parent 5fb4c1d commit f9257e8
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 35 deletions.
3 changes: 3 additions & 0 deletions input/commands/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ skupper system start [options]
skupper system stop [options]
skupper system reload [options]
skupper system status [options]
skupper system apply [options]
skupper system delete [options]
skupper system generate-bundle [options]
~~~

These commands configure and operate the Skupper runtime components
Expand Down
69 changes: 34 additions & 35 deletions input/resources/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,56 +58,55 @@ On Docker, Podman, and Linux, resources are stored on the local
filesystem under
`~/.local/share/skupper/namespaces/default/input/resources`.

The Skupper CLI provides additional commands to help create and
configure Skupper resources.
The Skupper CLI provides additional type-specific commands to help
create and configure Skupper resources.

#### Common properties
<!-- #### Common properties -->

- spec.settings
- spec.tlsCredentials
- status.Status
- status.Message
- status.Conditions
<!-- - spec.settings -->
<!-- - spec.tlsCredentials -->
<!-- - status.Status -->
<!-- - status.Message -->
<!-- - status.Conditions -->

#### Labels and annotations

{{lipsum()}}
<!-- #### Labels and annotations -->

## Primary resources

- **Site:** {{lipsum(10)}}
- **Link:** {{lipsum(10)}}
- **Listener:** {{lipsum(10)}}
- **Connector:** {{lipsum(10)}}

These are the main resources you interact with. The others are for
less common scenarios.
- [Site](site.html): A place on the network where application workloads are running
- [Link](link.html): A channel for communication between sites
- [Listener](listener.html): Binds a local connection endpoint to connectors in remote sites
- [Connector](connector.html): Binds a local workload to listeners in remote sites

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.
A site is a central concept in Skupper, representing a location on the
network where part of your application is running. It functions as
the foundational building block for your Skupper network, carrying all
the necessary configuration for that specific location. You can think
of it as the starting point for setting up your application network.

Links.... The Link resource is usually not created directly.
Instead, you use access tokens.
A link is a secure communication channel that joins two Skupper sites,
enabling your application to connect across sites. Links are the
backbone of a Skupper network, providing connectivity for distributed
applications to communicate across geographical boundaries and various
platforms.

Listener and connector are the key resources for service exposure.
Listeners and connectors enable you expose services on Skupper
networks. They work in tandem to bind client connection endpoints to
workloads that run in different locations.

## Site linking resources

- **Link:** {{lipsum(10)}}
- **AccessGrant:** {{lipsum(10)}}
- **AccessToken:** {{lipsum(10)}}
- **RouterAccess:** {{lipsum(10)}}

You may want to use the CLI (or some other automation) to do the
linking part.
- [Link](link.html): A channel for communication between sites
- [AccessGrant](access-grant.html): Permission to redeem access tokens for links to the local site
- [AccessToken](access-token.html): A short-lived credential used to create a link
- [RouterAccess](router-access.html): Configuration for secure access to the site router

## Service exposure resources

- **Listener:** {{lipsum(10)}}
- **Connector:** {{lipsum(10)}}
- **AttachedConnector:** {{lipsum(10)}}
- **AttachedConnectorBinding:** {{lipsum(10)}}
- [Listener](listener.html): Binds a local connection endpoint to connectors in remote sites
- [Connector](connector.html): Binds a local workload to listeners in remote sites
- [AttachedConnector](attached-connector.html): A connector in a peer namespace
- [AttachedConnectorBinding](attached-connector-binding.html): A binding to an attached connector in a peer namespace

<!-- ## Hello World using YAML -->

Expand Down

0 comments on commit f9257e8

Please sign in to comment.