Skip to content

Commit

Permalink
add notice module and notices for site creation (#365)
Browse files Browse the repository at this point in the history
Signed-off-by: Etai Lev Ran <[email protected]>
  • Loading branch information
elevran authored Feb 29, 2024
1 parent 9d7251f commit 6d560ab
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 10 deletions.
26 changes: 18 additions & 8 deletions website/content/en/docs/concepts/sites.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Once a `Site` has been added to a `Fabric`, it can communicate with any other `S

## Initializing a new Site

{{< notice warning >}}
Creating a new Site is a **Fabric** administrator level operation and should be appropriately protected.
{{< /notice >}}

### Prerequisites

The following assume that you have access to the `clusterlink` CLI and one or more
Expand All @@ -30,13 +34,13 @@ The following assume that you have access to the `clusterlink` CLI and one or mo

### Create a new Site certificate

Creating a new Site is a **Fabric** administrator level operation and should be appropriately protected.

To create a new Site certificate belonging to a fabric, confirm that the Fabric CA files
are available in the current working directory, and then execute the following CLI command:

> Note: The Fabric CA files (certificate and private key) are expected in the current
> working directory (i.e., `./<fabric_name>.crt` and `./<fabric_name>.key`).
{{< notice tip >}}
The Fabric CA files (certificate and private key) are expected in the current
working directory (i.e., `./<fabric_name>.crt` and `./<fabric_name>.key`).
{{< /notice >}}

```sh
clusterlink create site --name <site_name> --fabric <fabric_name>
Expand All @@ -47,16 +51,22 @@ This will create the certificate and private key files (`<site_name>.cert` and
created in a subdirectory named `<site_name>` under the current working directory.
You can override the default by setting the `--output <path>` option.

{{< notice info >}}
You will need the CA certificate (but **not** the CA private key) and the site certificate
and private in the next step. They can be provided out of band (e.g., over email) to the
site administrator.
{{< /notice >}}

### Deploy ClusterLink to a Site

This operation is typically done by a local *Site administrator*, typically different
than the *Fabric administrator*. Before proceeding, ensure that the CA certificate
(the CA private key is not needed), and the site certificate and key files which were
created in the previous step are in the current working directory.
{{< notice info >}}
This operation is typically done by a local *Site administrator*, usually different
than the *Fabric administrator*.
{{< /notice >}}

Before proceeding, ensure that the CA certificate (the CA private key is not needed),
and the site certificate and key files which were created in the previous step are
in the current working directory.

1. Install the ClusterLink deployment operator.

Expand Down
5 changes: 4 additions & 1 deletion website/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@ module github.com/clusterlink-net/clusterlink/website

go 1.20

require github.com/google/docsy v0.7.2 // indirect
require (
github.com/google/docsy v0.7.2 // indirect
github.com/martignoni/hugo-notice v0.0.0-20240113121429-9f516e6bedc3 // indirect
)
2 changes: 2 additions & 0 deletions website/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@ github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1
github.com/google/docsy v0.7.2 h1:KzhFgTd3taF1jq9HDemH3omlUqn9qfdE68sxRyTySpM=
github.com/google/docsy v0.7.2/go.mod h1:ol3w2s1FBUzENdKSAEeNjtuaISUzHYHTw60xv5QH3Dg=
github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
github.com/martignoni/hugo-notice v0.0.0-20240113121429-9f516e6bedc3 h1:UTgKycyAU48Q++K/cWcyPKE8FcbsCZtaluFuM0lIqFM=
github.com/martignoni/hugo-notice v0.0.0-20240113121429-9f516e6bedc3/go.mod h1:MIQPOMgEcbyRC0gNLzQFSgrS+wIy3RuQ/HbaZYtTOKU=
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
3 changes: 2 additions & 1 deletion website/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -208,4 +208,5 @@ min = "0.110.0"
path = "github.com/google/docsy"
[[module.imports]]
path = "github.com/google/docsy/dependencies"

[[module.imports]]
path = "github.com/martignoni/hugo-notice"

0 comments on commit 6d560ab

Please sign in to comment.