Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Jun 18, 2024
1 parent 3527506 commit a210150
Show file tree
Hide file tree
Showing 36 changed files with 218 additions and 51 deletions.
9 changes: 5 additions & 4 deletions config/commands.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@ groups:
- name: site
description: |
Display help for site commands and exit.
@resource_description@
inherit_standard_options: [help]
- name: site create
description: |
Create a site.
Expand Down Expand Up @@ -173,6 +172,8 @@ groups:
commands:
- name: token
resource: Claim
related_concepts: ["access grant", "access token"]
related_resources: [Grant, Claim]
description: |
Display help for token commands and exit.
inherit_standard_options: [help]
Expand Down Expand Up @@ -237,8 +238,6 @@ groups:
related_commands: [token]
description: |
Display help for link commands and exit.
@resource_description@
inherit_standard_options: [help]
- name: link create
description: |
Expand Down Expand Up @@ -292,6 +291,7 @@ groups:
- name: Service exposure
commands:
- name: connector
related_commands: [listener]
description: |
Display help for connector commands and exit.
inherit_standard_options: [help]
Expand Down Expand Up @@ -405,6 +405,7 @@ groups:
database database app=postgresql - 5432 1
inherit_standard_options: [output, namespace, context, platform, help]
- name: listener
related_commands: [connector]
description: |
Display help for listener commands and exit.
inherit_standard_options: [help]
Expand Down
6 changes: 2 additions & 4 deletions config/concepts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ groups:
- XXX link cost
- XXX only one direction needed
- name: link access
- name: grant
rename: Access grant
- name: access grant
links:
- name: Access token concept
url: /concepts/claim.html
Expand All @@ -59,8 +58,7 @@ groups:
URL and secret code to obtain a certificate signed by the
grant's certificate authority (CA), within a certain
expiration window and for a limited number of redemptions.
- name: claim
rename: Access token
- name: access token
links:
- name: Access grant concept
url: /concepts/grant.html
Expand Down
6 changes: 6 additions & 0 deletions input/commands/connector-create.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
body_class: command
links:
- name: Connector concept
url: /concepts/connector.html
- name: Connector resource
url: /resources/connector.html
- name: Connector command
url: /commands/connector.html
- name: Listener create command
url: /commands/listener-create.html
---
Expand Down
6 changes: 6 additions & 0 deletions input/commands/connector-delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
body_class: command
links:
- name: Connector concept
url: /concepts/connector.html
- name: Connector resource
url: /resources/connector.html
- name: Connector command
url: /commands/connector.html
- name: Listener delete command
url: /commands/listener-delete.html
---
Expand Down
7 changes: 7 additions & 0 deletions input/commands/connector-status.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Connector concept
url: /concepts/connector.html
- name: Connector resource
url: /resources/connector.html
- name: Connector command
url: /commands/connector.html
---

# Connector status command
Expand Down
6 changes: 6 additions & 0 deletions input/commands/connector-update.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
body_class: command
links:
- name: Connector concept
url: /concepts/connector.html
- name: Connector resource
url: /resources/connector.html
- name: Connector command
url: /commands/connector.html
- name: Listener update command
url: /commands/listener-update.html
---
Expand Down
2 changes: 2 additions & 0 deletions input/commands/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ links:
url: /concepts/connector.html
- name: Connector resource
url: /resources/connector.html
- name: Listener command
url: /commands/listener.html
---

# Connector command
Expand Down
3 changes: 3 additions & 0 deletions input/commands/debug-dump.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
body_class: command
links:
- name: Debug command
url: /commands/debug.html
---

# Debug dump command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/link-create.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Link concept
url: /concepts/link.html
- name: Link resource
url: /resources/link.html
- name: Link command
url: /commands/link.html
---

# Link create command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/link-delete.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Link concept
url: /concepts/link.html
- name: Link resource
url: /resources/link.html
- name: Link command
url: /commands/link.html
---

# Link delete command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/link-status.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Link concept
url: /concepts/link.html
- name: Link resource
url: /resources/link.html
- name: Link command
url: /commands/link.html
---

# Link status command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/link-update.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Link concept
url: /concepts/link.html
- name: Link resource
url: /resources/link.html
- name: Link command
url: /commands/link.html
---

# Link update command
Expand Down
7 changes: 0 additions & 7 deletions input/commands/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@ links:

Display help for link commands and exit.

A site-to-site communication channel. Links serve as a
transport for application connections and requests. A set
of linked sites constitute a network.

Links are not usually created directly. Instead, you
typically use an access token to obtain a link.

</section>

<section>
Expand Down
6 changes: 6 additions & 0 deletions input/commands/listener-create.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
body_class: command
links:
- name: Listener concept
url: /concepts/listener.html
- name: Listener resource
url: /resources/listener.html
- name: Listener command
url: /commands/listener.html
- name: Connector create command
url: /commands/connector-create.html
---
Expand Down
6 changes: 6 additions & 0 deletions input/commands/listener-delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
body_class: command
links:
- name: Listener concept
url: /concepts/listener.html
- name: Listener resource
url: /resources/listener.html
- name: Listener command
url: /commands/listener.html
- name: Connector delete command
url: /commands/connector-delete.html
---
Expand Down
7 changes: 7 additions & 0 deletions input/commands/listener-status.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Listener concept
url: /concepts/listener.html
- name: Listener resource
url: /resources/listener.html
- name: Listener command
url: /commands/listener.html
---

# Listener status command
Expand Down
6 changes: 6 additions & 0 deletions input/commands/listener-update.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
body_class: command
links:
- name: Listener concept
url: /concepts/listener.html
- name: Listener resource
url: /resources/listener.html
- name: Listener command
url: /commands/listener.html
- name: Connector update command
url: /commands/connector-update.html
---
Expand Down
2 changes: 2 additions & 0 deletions input/commands/listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ links:
url: /concepts/listener.html
- name: Listener resource
url: /resources/listener.html
- name: Connector command
url: /commands/connector.html
---

# Listener command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/site-create.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Site concept
url: /concepts/site.html
- name: Site resource
url: /resources/site.html
- name: Site command
url: /commands/site.html
---

# Site create command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/site-delete.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Site concept
url: /concepts/site.html
- name: Site resource
url: /resources/site.html
- name: Site command
url: /commands/site.html
---

# Site delete command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/site-status.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Site concept
url: /concepts/site.html
- name: Site resource
url: /resources/site.html
- name: Site command
url: /commands/site.html
---

# Site status command
Expand Down
7 changes: 7 additions & 0 deletions input/commands/site-update.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
---
body_class: command
links:
- name: Site concept
url: /concepts/site.html
- name: Site resource
url: /resources/site.html
- name: Site command
url: /commands/site.html
---

# Site update command
Expand Down
15 changes: 12 additions & 3 deletions input/commands/site.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,18 @@ links:

Display help for site commands and exit.

A place where components of your application are running.
Sites are linked to form application networks.
</section>

<section>

## Options

- <h3 id="help">--help <span class="option-info"></span></h3>

There can be only one site resource per namespace.
Display help and exit.

| | |
|-|-|
| Platforms | Kubernetes, Docker |

</section>
2 changes: 2 additions & 0 deletions input/commands/token-issue.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
body_class: command
links:
- name: Token command
url: /commands/token.html
- name: Token redeem command
url: /commands/token-redeem.html
---
Expand Down
2 changes: 2 additions & 0 deletions input/commands/token-redeem.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
body_class: command
links:
- name: Token command
url: /commands/token.html
- name: Token issue command
url: /commands/token-issue.html
---
Expand Down
9 changes: 9 additions & 0 deletions input/commands/token.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
---
body_class: command
links:
- name: Access grant concept
url: /concepts/access-grant.html
- name: Access token concept
url: /concepts/access-token.html
- name: AccessGrant resource
url: /resources/grant.html
- name: AccessToken resource
url: /resources/claim.html
---

# Token command
Expand Down
20 changes: 20 additions & 0 deletions input/concepts/access-grant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
body_class: concept
links:
- name: Access token concept
url: /concepts/claim.html
- name: Token issue command
url: /commands/token-issue.html
---

# Access grant concept

<section>

Permission to redeem access tokens for links to the local
site. A remote site can use a token containing the grant
URL and secret code to obtain a certificate signed by the
grant's certificate authority (CA), within a certain
expiration window and for a limited number of redemptions.

</section>
Loading

0 comments on commit a210150

Please sign in to comment.