Skip to content

Commit c7f4e4d

Browse files
authored
Readme updates (#2053)
* fix readmes to provide yaml install - links from helm to controller readmes
1 parent c94a0af commit c7f4e4d

4 files changed

Lines changed: 42 additions & 30 deletions

File tree

charts/README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,9 @@
22

33
### Skupper chart
44

5-
The skupper chart is generated from common config files, so you will need to run:
6-
```asciidoc
7-
make generate-skupper-helm-chart
8-
```
9-
10-
This action will create a `skupper` chart inside the `charts` directory, that
11-
you can install with a clustered scope with:
12-
```
13-
helm install skupper ./skupper --set scope=cluster
14-
```
15-
Other option is to install it in a namespaced scope:
16-
```
17-
helm install skupper ./skupper --set scope=namespace
18-
```
19-
20-
Check the `values.yaml` to modify the image tag of the controller, kube-adaptor and router images.
21-
5+
[Instructions on how to deploy the Skupper chart](skupper/README.md)
226

237
### Network-observer chart
248

25-
[Instructions on how to deploy the network-observer chart.](https://github.com/skupperproject/skupper/blob/main/charts/network-observer/README.md)
9+
[Instructions on how to deploy the network-observer chart](network-observer/README.md)
2610

charts/skupper/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,24 @@ routerImage: examplemirror.acme.com/skupper/skupper-router:3.3.0
5252

5353
## Alternative Installation Methods
5454

55-
In addition to this Helm Chart, Skupper releases static manifest yamls for
55+
In addition to this Helm Chart, Skupper releases static manifest [YAML](../../cmd/controller/README.md) for
5656
deploying both cluster and namespace-scoped controllers.
5757

58-
```
59-
SKUPPER_VERSION=2.0.0
60-
# Deploys a cluster scoped controller to the 'skupper' namespace.
61-
kubectl apply -f "https://github.com/skupperproject/skupper/releases/download/$SKUPPER_VERSION/skupper-cluster-scope.yaml"
62-
# Deploys a namespace scoped controller to the current context namespace.
63-
kubectl apply -f "https://github.com/skupperproject/skupper/releases/download/$SKUPPER_VERSION/skupper-namespace-scope.yaml"
58+
## Development
59+
60+
The skupper chart is generated from common config files, so you will need to run:
61+
```asciidoc
62+
make generate-skupper-helm-chart
6463
```
6564

66-
## Development
65+
This action will create a `skupper` chart inside the `charts` directory, that
66+
you can install with a clustered scope with:
67+
```
68+
helm install skupper ./skupper --set scope=cluster
69+
```
70+
Other option is to install it in a namespaced scope:
71+
```
72+
helm install skupper ./skupper --set scope=namespace
73+
```
6774

68-
This Helm Chart is generated. For instructions on working with this chart see
69-
[skupper/charts](https://github.com/skupperproject/skupper/tree/main/charts).
75+
Check the `values.yaml` to modify the image tag of the controller, kube-adaptor and router images.

cmd/controller/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Skupper controller
2+
3+
Skupper releases static manifest yamls for deploying both cluster and namespace-scoped controllers.
4+
5+
```
6+
SKUPPER_VERSION=v2-dev-release
7+
# Deploys a cluster scoped controller to the 'skupper' namespace.
8+
kubectl apply -f "https://github.com/skupperproject/skupper/releases/download/$SKUPPER_VERSION/skupper-cluster-scope.yaml"
9+
# Deploys a namespace scoped controller to the current context namespace.
10+
kubectl apply -f "https://github.com/skupperproject/skupper/releases/download/$SKUPPER_VERSION/skupper-namespace-scope.yaml"
11+
```
12+
13+
Alternatively, clone this repo and generate the YAML files using:
14+
15+
```
16+
make generate-skupper-deployment-cluster-scoped
17+
make generate-skupper-deployment-namespace-scoped
18+
```
19+
20+
You can also install using [Helm charts](../../charts/README.md).

cmd/controller/example/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ This example demonstrates how to connect two sites declaratively, without relyin
44

55
## Installing the skupper controller
66

7-
The controller can be installed using the Helm chart, with detailed instructions provided
8-
[here](https://github.com/skupperproject/skupper/blob/main/charts/README.md)
7+
The controller can be installed using:
8+
9+
* [YAML](../README.md)
10+
* [Helm chart](../../../charts/README.md)
911

1012
## Deploy application in two namespaces (or contexts)
1113

0 commit comments

Comments
 (0)