Skip to content

Commit 6d560ab

Browse files
authored
add notice module and notices for site creation (#365)
Signed-off-by: Etai Lev Ran <elevran@gmail.com>
1 parent 9d7251f commit 6d560ab

File tree

4 files changed

+26
-10
lines changed

4 files changed

+26
-10
lines changed

website/content/en/docs/concepts/sites.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Once a `Site` has been added to a `Fabric`, it can communicate with any other `S
2020

2121
## Initializing a new Site
2222

23+
{{< notice warning >}}
24+
Creating a new Site is a **Fabric** administrator level operation and should be appropriately protected.
25+
{{< /notice >}}
26+
2327
### Prerequisites
2428

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

3135
### Create a new Site certificate
3236

33-
Creating a new Site is a **Fabric** administrator level operation and should be appropriately protected.
34-
3537
To create a new Site certificate belonging to a fabric, confirm that the Fabric CA files
3638
are available in the current working directory, and then execute the following CLI command:
3739

38-
> Note: The Fabric CA files (certificate and private key) are expected in the current
39-
> working directory (i.e., `./<fabric_name>.crt` and `./<fabric_name>.key`).
40+
{{< notice tip >}}
41+
The Fabric CA files (certificate and private key) are expected in the current
42+
working directory (i.e., `./<fabric_name>.crt` and `./<fabric_name>.key`).
43+
{{< /notice >}}
4044

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

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

5460
### Deploy ClusterLink to a Site
5561

56-
This operation is typically done by a local *Site administrator*, typically different
57-
than the *Fabric administrator*. Before proceeding, ensure that the CA certificate
58-
(the CA private key is not needed), and the site certificate and key files which were
59-
created in the previous step are in the current working directory.
62+
{{< notice info >}}
63+
This operation is typically done by a local *Site administrator*, usually different
64+
than the *Fabric administrator*.
65+
{{< /notice >}}
66+
67+
Before proceeding, ensure that the CA certificate (the CA private key is not needed),
68+
and the site certificate and key files which were created in the previous step are
69+
in the current working directory.
6070

6171
1. Install the ClusterLink deployment operator.
6272

website/go.mod

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@ module github.com/clusterlink-net/clusterlink/website
22

33
go 1.20
44

5-
require github.com/google/docsy v0.7.2 // indirect
5+
require (
6+
github.com/google/docsy v0.7.2 // indirect
7+
github.com/martignoni/hugo-notice v0.0.0-20240113121429-9f516e6bedc3 // indirect
8+
)

website/go.sum

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1
22
github.com/google/docsy v0.7.2 h1:KzhFgTd3taF1jq9HDemH3omlUqn9qfdE68sxRyTySpM=
33
github.com/google/docsy v0.7.2/go.mod h1:ol3w2s1FBUzENdKSAEeNjtuaISUzHYHTw60xv5QH3Dg=
44
github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
5+
github.com/martignoni/hugo-notice v0.0.0-20240113121429-9f516e6bedc3 h1:UTgKycyAU48Q++K/cWcyPKE8FcbsCZtaluFuM0lIqFM=
6+
github.com/martignoni/hugo-notice v0.0.0-20240113121429-9f516e6bedc3/go.mod h1:MIQPOMgEcbyRC0gNLzQFSgrS+wIy3RuQ/HbaZYtTOKU=
57
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

website/hugo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,4 +208,5 @@ min = "0.110.0"
208208
path = "github.com/google/docsy"
209209
[[module.imports]]
210210
path = "github.com/google/docsy/dependencies"
211-
211+
[[module.imports]]
212+
path = "github.com/martignoni/hugo-notice"

0 commit comments

Comments
 (0)