Skip to content

Some small README improvements #886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: release-1.16
Choose a base branch
from
Open

Some small README improvements #886

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,13 @@ For a complete list of SMM features please check out the [SMM docs](https://smm-
### Build and deploy
Download or check out the latest stable release.

Run `make deploy` to deploy the operator controller-manager on your kubernetes cluster.
Run `make deploy` to deploy the operator controller-manager on your kubernetes cluster. To use the pre-built images do not set the TAG environment variable.

Check if the controller is running in the `istio-system` namespace:
```
$ kubectl get pod -n istio-system

```
```
Comment on lines +77 to +78
Copy link
Member

@Laci21 Laci21 Feb 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this was deliberately one section. First the command and then the output of the command in one section.

NAME READY STATUS RESTARTS AGE
istio-operator-controller-manager-6f764787c-rbnht 2/2 Running 0 5m18s
```
Expand All @@ -85,11 +86,18 @@ $ kubectl -n istio-system apply -f config/samples/servicemesh_v1alpha1_istiocont
istiocontrolplane.servicemesh.cisco.com/icp-v116x-sample created
```

Label the namespace, where you would like to enable sidecar injection for your pods. The label should consist of the name of the deployed IstioControlPlane and the namespace where it is deployed.
Create and label the namespace, where you would like to enable sidecar injection for your pods. The label should consist of the name of the deployed IstioControlPlane and the namespace where it is deployed.
```
$ kubectl label namespace demoapp istio.io/rev=icp-v116x-sample.istio-system
namespace/demoapp labeled
```
```
kubectl get pods -n istio-system
NAME READY STATUS RESTARTS AGE
istio-operator-controller-manager-7875df958d-v4h7l 2/2 Running 0 17h
istiod-icp-v116x-sample-7b499b7d-gps2b 1/1 Running 0 17h```
Copy link
Member

@Laci21 Laci21 Feb 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
istiod-icp-v116x-sample-7b499b7d-gps2b 1/1 Running 0 17h```
istiod-icp-v116x-sample-7b499b7d-gps2b 1/1 Running 0 17h

```
Note the `icp-v116x-sample` string in both outputs
Copy link
Member

@Laci21 Laci21 Feb 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do u mean by "both" here exactly? I can only see the string in "istiod-icp-v116x-sample-7b499b7d-gps2b", but not in "istio-operator-controller-manager-7875df958d-v4h7l".


Deploy the [Istio ingress gateway sample](config/samples/servicemesh_v1alpha1_istiomeshgateway.yaml) to your desired namespace
```
Expand Down Expand Up @@ -132,10 +140,9 @@ reviews-v3-84779c7bbc-t5rfq 2/2 Running 0 33s
Deploy the VirtualService and Gateway needed for your application.
**For the [demo bookinfo](https://raw.githubusercontent.com/istio/istio/master/samples/bookinfo/networking/bookinfo-gateway.yaml) application, you need to modify the Istio Gateway entry!** The `spec.selector.istio` field should be set from `ingressgateway` to `imgw-sample` so it will be applied to the sample IstioMeshGateway deployed before. The port needs to be set to the targetPort of the deployed IstioMeshGateway.
```
curl https://raw.githubusercontent.com/istio/istio/master/samples/bookinfo/networking/bookinfo-gateway.yaml | sed 's/istio: ingressgateway # use istio default controller/istio: imgw-sample/g;s/number: 80/number: 9080/g' | kubectl apply -f -
curl https://raw.githubusercontent.com/istio/istio/master/samples/bookinfo/networking/bookinfo-gateway.yaml | sed 's/istio: ingressgateway # use istio default controller/istio: imgw-sample/g;s/number: 80/number: 9080/g' | kubectl apply -n demoapp -f -
```
```
$ kubectl -n demoapp apply -f bookinfo-gateway.yaml
Copy link
Member

@Laci21 Laci21 Feb 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this should be deleted.

gateway.networking.istio.io/bookinfo-gateway created
virtualservice.networking.istio.io/bookinfo created
```
Expand Down