Skip to content

Commit e276b34

Browse files
authored
manifests: store docs manifests in same repo (openservicemesh#308)
Stores the manifests used by the docs repo from osm/docs/examples/manifests in the osm-docs repo. This makes it easier to update and maintain the manifests used by the website without needing to make changes across 2 repos. Resolves openservicemesh#242 Signed-off-by: Shashank Ram <[email protected]>
1 parent 2bce33b commit e276b34

33 files changed

+1006
-36
lines changed

content/docs/demos/canary_rollout.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following steps demonstrate the canary rollout deployment strategy.
4242
osm namespace add curl
4343
4444
# Deploy curl client in the curl namespace
45-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/curl/curl.yaml -n curl
45+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/curl/curl.yaml -n curl
4646
```
4747

4848
Confirm the `curl` client pod is up and running.
@@ -62,13 +62,13 @@ The following steps demonstrate the canary rollout deployment strategy.
6262
osm namespace add httpbin
6363
6464
# Create the httpbin root service and service account
65-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/canary/httpbin.yaml -n httpbin
65+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/canary/httpbin.yaml -n httpbin
6666
```
6767

6868
1. Deploy version `v1` of the `httpbin` service. The service `httpbin-v1` has the selector `app: httpbin, version: v1`, and the deployment `httpbin-v1` has the labels `app: httpbin, version: v1` matching the selector of both the `httpbin` root service and `httpbin-v1` service.
6969

7070
```bash
71-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/canary/httpbin-v1.yaml -n httpbin
71+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/canary/httpbin-v1.yaml -n httpbin
7272
```
7373

7474
1. Create an SMI TrafficSplit resource that directs all traffic to the `httpbin-v1` service.
@@ -119,7 +119,7 @@ The following steps demonstrate the canary rollout deployment strategy.
119119
1. Prepare the canary rollout by deploying version `v2` of the `httpbin` service. The service `httpbin-v2` has the selector `app: httpbin, version: v2`, and the deployment `httpbin-v2` has the labels `app: httpbin, version: v2` matching the selector of both the `httpbin` root service and `httpbin-v2` service.
120120
121121
```bash
122-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/canary/httpbin-v2.yaml -n httpbin
122+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/canary/httpbin-v2.yaml -n httpbin
123123
```
124124
125125
1. Perform the canary rollout by updating the SMI TrafficSplit resource to split traffic directed to the root service FQDN `httpbin.httpbin.svc.cluster.local` to both the `httpbin-v1` and `httpbin-v2` services, fronting the `v1` and `v2` versions of the `httpbin` service respectively. We will distribute the weight equally to demonstrate traffic splitting.

content/docs/demos/egress_passthrough.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This guide demonstrates a client within the service mesh accessing destinations
3333
osm namespace add curl
3434
3535
# Deploy curl client in the curl namespace
36-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/curl/curl.yaml -n curl
36+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/curl/curl.yaml -n curl
3737
```
3838

3939
Confirm the `curl` client pod is up and running.

content/docs/demos/egress_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This guide demonstrates a client within the service mesh accessing destinations
3333
osm namespace add curl
3434
3535
# Deploy curl client in the curl namespace
36-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/curl/curl.yaml -n curl
36+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/curl/curl.yaml -n curl
3737
```
3838

3939
Confirm the `curl` client pod is up and running.

content/docs/demos/ingress_contour.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ kubectl create ns httpbin
6262
osm namespace add httpbin
6363

6464
# Deploy the application
65-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/httpbin/httpbin.yaml -n httpbin
65+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/httpbin/httpbin.yaml -n httpbin
6666
```
6767

6868
Confirm the `httpbin` service and pod is up and running:

content/docs/demos/ingress_k8s_nginx.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ kubectl create ns httpbin
4343
osm namespace add httpbin
4444

4545
# Deploy the application
46-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/httpbin/httpbin.yaml -n httpbin
46+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/httpbin/httpbin.yaml -n httpbin
4747
```
4848

4949
Confirm the `httpbin` service and pod is up and running:

content/docs/demos/outbound_ip_exclusion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The following demo shows an HTTP `curl` client making HTTP requests to the `http
3535
osm namespace add curl
3636
3737
# Deploy curl client in the curl namespace
38-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/curl/curl.yaml -n curl
38+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/curl/curl.yaml -n curl
3939
```
4040

4141
Confirm the `curl` client pod is up and running.

content/docs/demos/permissive_traffic_mode.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The following demo shows an HTTP `curl` client making HTTP requests to the `http
3636
osm namespace add httpbin
3737
3838
# Deploy httpbin service in the httpbin namespace
39-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/httpbin/httpbin.yaml -n httpbin
39+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/httpbin/httpbin.yaml -n httpbin
4040
```
4141

4242
Confirm the `httpbin` service and pods are up and running.
@@ -63,7 +63,7 @@ The following demo shows an HTTP `curl` client making HTTP requests to the `http
6363
osm namespace add curl
6464
6565
# Deploy curl client in the curl namespace
66-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/curl/curl.yaml -n curl
66+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/curl/curl.yaml -n curl
6767
```
6868

6969
Confirm the `curl` client pod is up and running.

content/docs/demos/tcp_traffic_routing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The following demo shows a TCP client sending data to a `tcp-echo` server, which
3434
osm namespace add tcp-demo
3535
3636
# Deploy the service
37-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/tcp-echo.yaml -n tcp-demo
37+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/tcp-echo.yaml -n tcp-demo
3838
```
3939

4040
Confirm the `tcp-echo` service and pod is up and running.
@@ -58,7 +58,7 @@ The following demo shows a TCP client sending data to a `tcp-echo` server, which
5858
osm namespace add curl
5959
6060
# Deploy curl client in the curl namespace
61-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/samples/curl/curl.yaml -n curl
61+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/curl/curl.yaml -n curl
6262
```
6363

6464
Confirm the `curl` client pod is up and running.

content/docs/getting_started/install_apps.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ We are going to define and deploy traffic access policies using [SMI](https://sm
2121
state of allowed and blocked traffic between pods:
2222

2323
| from / to: | bookbuyer | bookthief | bookstore | bookwarehouse | mysql |
24-
|---------------|-----------|-----------|-----------|---------------|-------|
25-
| bookbuyer | n/a | | | | |
26-
| bookthief | | n/a | | | |
27-
| bookstore | | | n/a | | |
28-
| bookwarehouse | | | | n/a | |
29-
| mysql | | | | | n/a |
24+
| ------------- | --------- | --------- | --------- | ------------- | ----- |
25+
| bookbuyer | n/a | | | | |
26+
| bookthief | | n/a | | | |
27+
| bookstore | | | n/a | | |
28+
| bookwarehouse | | | | n/a | |
29+
| mysql | | | | | n/a |
3030

3131

3232
To show how to split traffic using SMI Traffic Split, we will deploy an additional application:
@@ -60,31 +60,31 @@ on these namespaces, will start injecting all **new** pods with Envoy sidecars.
6060
Create the `bookbuyer` service account and deployment:
6161

6262
```bash
63-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/bookbuyer.yaml
63+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/bookbuyer.yaml
6464
```
6565

6666
Create the `bookthief` service account and deployment:
6767

6868
```bash
69-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/bookthief.yaml
69+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/bookthief.yaml
7070
```
7171

7272
Create the `bookstore` service account, service, and deployment:
7373

7474
```bash
75-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/bookstore.yaml
75+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/bookstore.yaml
7676
```
7777

7878
Create the `bookwarehouse` service account, service, and deployment:
7979

8080
```bash
81-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/bookwarehouse.yaml
81+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/bookwarehouse.yaml
8282
```
8383

8484
Create the `mysql` service account, service, and stateful set:
8585

8686
```bash
87-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/mysql.yaml
87+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/mysql.yaml
8888
```
8989

9090
### Checkpoint: What Got Installed?

content/docs/getting_started/traffic_policies.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ In permissive traffic policy mode, application connectivity within the mesh is a
4747

4848
Before proceeding, [verify the traffic policy mode](#verify-the-traffic-policy-mode) and ensure the `enablePermissiveTrafficPolicyMode` key is set to `true` in the `osm-mesh-config` `MeshConfig` resource. Refer to the section above to enable permissive traffic policy mode.
4949

50-
In step [Deploy the Bookstore Application](#deploy-the-bookstore-application), we have already deployed the applications needed to verify traffic flow in permissive traffic policy mode. The `bookstore` service we previously deployed is encoded with an identity of `bookstore-v1` for demo purpose, as can be seen in the [Deployment's manifest](https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/bookstore.yaml). The identity reflects which counter increments in the `bookbuyer` and `bookthief` UI, and the identity displayed in the `bookstore` UI.
50+
In step [Deploy the Bookstore Application](#deploy-the-bookstore-application), we have already deployed the applications needed to verify traffic flow in permissive traffic policy mode. The `bookstore` service we previously deployed is encoded with an identity of `bookstore-v1` for demo purpose, as can be seen in the [Deployment's manifest](https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/bookstore.yaml). The identity reflects which counter increments in the `bookbuyer` and `bookthief` UI, and the identity displayed in the `bookstore` UI.
5151

5252
The counter in the `bookbuyer`, `bookthief` UI for the books bought and stolen respectively from `bookstore v1` should now be incrementing:
5353

@@ -93,7 +93,7 @@ Apply the [SMI Traffic Target][https://github.com/servicemeshinterface/smi-spec/
9393
Deploy SMI TrafficTarget and HTTPRouteGroup policy:
9494

9595
```bash
96-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/access/traffic-access-v1.yaml
96+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/access/traffic-access-v1.yaml
9797
```
9898

9999
The counters should now be incrementing for the `bookbuyer`, and `bookstore` applications:
@@ -167,7 +167,7 @@ spec:
167167
Apply the updated TrafficTarget:
168168

169169
```bash
170-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/access/traffic-access-v1-allow-bookthief.yaml
170+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/access/traffic-access-v1-allow-bookthief.yaml
171171
```
172172

173173
The counter in the `bookthief` window will start incrementing.
@@ -177,7 +177,7 @@ The counter in the `bookthief` window will start incrementing.
177177
Apply the original Traffic Target object without the bookthief listed as an allowed source:
178178

179179
```bash
180-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/access/traffic-access-v1.yaml
180+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/access/traffic-access-v1.yaml
181181
```
182182

183183
The counter in the `bookthief` window will stop incrementing.

content/docs/getting_started/traffic_split.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To demonstrate usage of SMI traffic access and split policies, we will now deplo
1616
```bash
1717
# Contains the bookstore-v2 Kubernetes Service, Service Account, Deployment and SMI Traffic Target resource to allow
1818
# `bookbuyer` to communicate with `bookstore-v2` pods
19-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/apps/bookstore-v2.yaml
19+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/apps/bookstore-v2.yaml
2020
```
2121

2222
Wait for the `bookstore-v2` pod to be running in the `bookstore` namespace. Next, exit and restart the `./scripts/port-forward-all.sh` script in order to access v2 of bookstore.
@@ -30,7 +30,7 @@ The counter should _not_ be incrementing because no traffic is flowing yet to th
3030
Deploy the SMI traffic split policy to direct 100 percent of the traffic sent to the root `bookstore` service to the `bookstore` service backend:
3131

3232
```bash
33-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/split/traffic-split-v1.yaml
33+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/split/traffic-split-v1.yaml
3434
```
3535

3636
_Note: The root service can be any Kubernetes service. It does not have any label selectors. It also doesn't need to overlap with any of the Backend services specified in the Traffic Split resource. The root service can be referred to in the SMI Traffic Split resource as the name of the service with or without the `.<namespace>` suffix._
@@ -46,7 +46,7 @@ kubectl describe trafficsplit bookstore-split -n bookstore
4646
Update the SMI Traffic Split policy to direct 50 percent of the traffic sent to the root `bookstore` service to the `bookstore` service and 50 perfect to `bookstore-v2` service by adding the `bookstore-v2` backend to the spec and modifying the weight fields.
4747

4848
```bash
49-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/split/traffic-split-50-50.yaml
49+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/split/traffic-split-50-50.yaml
5050
```
5151

5252
Wait for the changes to propagate and observe the counters increment for `bookstore` and `bookstore-v2` in your browser windows. Both
@@ -60,7 +60,7 @@ counters should be incrementing:
6060
Update the `bookstore-split` TrafficSplit to configure all traffic to go to `bookstore-v2`:
6161

6262
```bash
63-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/split/traffic-split-v2.yaml
63+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/split/traffic-split-v2.yaml
6464
```
6565

6666
Wait for the changes to propagate and observe the counters increment for `bookstore-v2` and freeze for `bookstore` in your

content/docs/guides/integrations/external_auth_opa.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ cd <PATH_TO_OSM_REPO>
3333
demo/run-osm-demo.sh # wait for all services to come up
3434
```
3535

36-
- When OSM's demo is up and running, proceed to deploy `opa-envoy-plugin`. OSM provides a [curated standalone opa-envoy-plugin deployment chart](https://github.com/openservicemesh/osm/blob/{{< param osm_branch >}}/docs/example/manifests/opa/deploy-opa-envoy.yaml) which exposes `opa-envoy-plugin`'s gRPC port (default `9191`) through a service, over the network. This is the endpoint that OSM will configure the proxies with when enabling external authorization. The following snippet creates an `opa` namespace and deploys `opa-envoy-plugin` in it with minimal deny-all configuration:
36+
- When OSM's demo is up and running, proceed to deploy `opa-envoy-plugin`. OSM provides a [curated standalone opa-envoy-plugin deployment chart](https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/opa/deploy-opa-envoy.yaml) which exposes `opa-envoy-plugin`'s gRPC port (default `9191`) through a service, over the network. This is the endpoint that OSM will configure the proxies with when enabling external authorization. The following snippet creates an `opa` namespace and deploys `opa-envoy-plugin` in it with minimal deny-all configuration:
3737

3838
```
3939
kubectl create namespace opa
40-
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/{{< param osm_branch >}}/docs/example/manifests/opa/deploy-opa-envoy.yaml
40+
kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/opa/deploy-opa-envoy.yaml
4141
```
4242

4343
- Once OSM's demo is up and running, proceed to edit OSM's MeshConfig to add external authorization to the mesh. For that, configure the `inboundExternalAuthorization` to point to the remote external authorization endpoint as follows:

content/docs/guides/integrations/prometheus.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ To familiarize yourself on how OSM works with Prometheus, try installing a new m
4343
1. Install sample applications:
4444

4545
```console
46-
$ kubectl apply -f docs/example/manifests/samples/curl/curl.yaml -n metrics-demo
46+
$ kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/curl/curl.yaml -n metrics-demo
4747
serviceaccount/curl created
4848
deployment.apps/curl created
49-
$ kubectl apply -f docs/example/manifests/samples/httpbin/httpbin.yaml -n metrics-demo
49+
$ kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm-docs/{{< param osm_branch >}}/manifests/samples/httpbin/httpbin.yaml -n metrics-demo
5050
serviceaccount/httpbin created
5151
service/httpbin created
5252
deployment.apps/httpbin created

0 commit comments

Comments
 (0)