Skip to content

Commit

Permalink
minor edits from @welisheva (#584)
Browse files Browse the repository at this point in the history
Signed-off-by: Etai Lev Ran <[email protected]>
  • Loading branch information
elevran authored May 19, 2024
1 parent 5e56a66 commit 775bb85
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 19 deletions.
2 changes: 1 addition & 1 deletion website/content/en/docs/main/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Core Concepts
description: Core Concepts of the ClusterLink system.
description: Core Concepts of the ClusterLink system
weight: 30
---
4 changes: 2 additions & 2 deletions website/content/en/docs/main/concepts/fabric.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 10
The concept of a *Fabric* encapsulates a set of cooperating [peers][].
All peers in a fabric can communicate and may share [services][]
between them, with access governed by [policies][].
The Fabric acts as a root of trust for peer to peer communications (i.e.,
The Fabric acts as a root of trust for peer-to-peer communications (i.e.,
it functions as the certificate authority enabling mutual authentication between
peers).

Expand All @@ -24,7 +24,7 @@ Currently, the concept of a Fabric is just that - a concept. It is not represent

### Prerequisites

The following assume that you have access to the `clusterlink` CLI and one or more
The following sections assume that you have access to the `clusterlink` CLI and one or more
peers (i.e., clusters) where you'll deploy ClusterLink. The CLI can be downloaded
from the ClusterLink [releases page on GitHub][].

Expand Down
34 changes: 19 additions & 15 deletions website/content/en/docs/main/concepts/peers.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ weight: 20

A *Peer* represents a location, such as a Kubernetes cluster, participating in a
[fabric][]. Each peer may host one or more [services][]
it wishes to share with other peers. A peer is managed by a peer administrator,
that it may wish to share with other peers. A peer is managed by a peer administrator,
which is responsible for running the ClusterLink control and data planes. The
administrator will typically deploy the ClusterLink components by configuring
the [deployment CR][]. They may also wish to provide
(often) coarse-grained access policies in accordance with high level corporate
the [deployment Custom Resource (CR)][operator-cr]. The administrator may also wish
to provide coarse-grained access policies (and often do) in accordance with high level corporate
policies (e.g., "production peers should only communicate with other production peers").

Once a peer has been added to a fabric, it can communicate with any other peer
belonging to it. All configuration relating to service sharing (e.g., the exporting
and importing of services, and the setting of fine grained application policies) can be
done with lowered privileges (e.g., by users, such as application owners). Remote peers are
represented by the Peer Custom Resource Definition (CRD). Each Peer CR instance
represented by peer Custom Resources (CRs). Each Peer CR instance
defines a remote cluster and the network endpoints of its ClusterLink gateways.

## Prerequisites

The following assume that you have access to the `clusterlink` CLI and one or more
The following sections assume that you have access to the `clusterlink` CLI and one or more
peers (i.e., clusters) where you'll deploy ClusterLink. The CLI can be downloaded
from the ClusterLink [releases page on GitHub][].
It also assumes that you have access to the [previously created fabric][]
Expand All @@ -37,8 +37,9 @@ Creating a new peer is a **fabric administrator** level operation and should be

### Create a new peer certificate

To create a new peer 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:
To create a new peer certificate belonging to a fabric, confirm that the fabric
Certificate Authority (CA) files are available in the current working directory,
and then execute the following CLI command:

```sh
clusterlink create peer-cert --name <peer_name> --fabric <fabric_name>
Expand All @@ -55,9 +56,9 @@ This will create the certificate and private key files (`cert.pem` and
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 peer certificate
and private in the next step. They can be provided out of band (e.g., over email) to the
peer administrator.
You will need the CA certificate (but **not** the CA private key) and the peer's certificate
and private key pair in the next step. They can be provided out of band (e.g., over email) to the
peer administrator or by any other means for secure transfer of sensitive data.
{{< /notice >}}

## Deploy ClusterLink to a new peer
Expand All @@ -67,9 +68,12 @@ This operation is typically done by a local **peer administrator**, usually diff
than the **fabric administrator**.
{{< /notice >}}

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

1. CA certificate;
1. peer certificate; and
1. peer private key.

### Install the ClusterLink deployment operator

Expand Down Expand Up @@ -180,7 +184,7 @@ There are two fundamental attributes in the peer CRD: the peer name and the list
during connection establishment. The name is used by importers in referencing an export
(see [services][] for details).

Gateway endpoint would typically be a implemented via a `NodePort` or `LoadBalancer`
Gateway endpoint would typically be implemented via a `NodePort` or `LoadBalancer`
K8s service. A `NodePort` service would typically be used in local deployments
(e.g., when running in kind clusters during development) and a `LoadBalancer` service
would be used in cloud based deployments. These can be automatically configured and
Expand All @@ -197,7 +201,7 @@ Gateway endpoint would typically be a implemented via a `NodePort` or `LoadBalan
Once a peer has been created and initialized with the ClusterLink control and data
planes as well as one or more remote peers, you can proceed with configuring
[services][] and [policies][].
For a complete end to end use case, refer to the [iperf tutorial][].
For a complete end-to-end use case, refer to the [iperf tutorial][].

[fabric]: {{< relref "fabric" >}}
[previously created fabric]: {{< relref "fabric#create-a-new-fabric-ca" >}}
Expand Down
2 changes: 1 addition & 1 deletion website/content/en/docs/main/getting-started/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here are the key steps for setting up your developer environment, making a chang
[contribution guide][].
- We follow [GitHub's Standard Fork & Pull Request Workflow][].

All contributed code should should pass precommit checks such as linting and tests. These
All contributed code should pass precommit checks such as linting and other tests. These
are run automatically as part of the CI process on every pull request. You may wish to
run these locally, before initiating a PR:

Expand Down

0 comments on commit 775bb85

Please sign in to comment.