Skip to content
This repository was archived by the owner on May 6, 2022. It is now read-only.

Commit c654175

Browse files
adamwalachmszostok
adamwalach
authored and
mszostok
committed
Update documentation (v0.2) (#2693)
1 parent 309ba89 commit c654175

File tree

4 files changed

+19
-25
lines changed

4 files changed

+19
-25
lines changed

‎docs/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Catalog API server to get the list of `ClusterServiceBroker` resources.
120120

121121
The current version of all Service Catalog API resources is `v1beta1`.
122122
You can see the structure of each resource in detail at
123-
[`pkg/apis/servicecatalog/v1beta1/types.go`](https://github.com/kubernetes-sigs/service-catalog/blob/master/pkg/apis/servicecatalog/v1beta1/types.go).
123+
[`pkg/apis/servicecatalog/v1beta1/types.go`](https://github.com/kubernetes-sigs/service-catalog/blob/v0.2/pkg/apis/servicecatalog/v1beta1/types.go).
124124

125125
### Controller
126126

‎docs/devguide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ functionality or introduce instability. See [FeatureGates](feature-gates.md)
345345
for more details.
346346

347347
When adding a FeatureGate to Helm charts, define the variable
348-
`fooEnabled` with a value of `false` in [values.yaml](https://github.com/kubernetes-sigs/service-catalog/blob/master/charts/catalog-v0.2/values.yaml). In the [API Server](https://github.com/kubernetes-sigs/service-catalog/blob/master/charts/catalog-v0.2/templates/apiserver-deployment.yaml) and [Controller](https://github.com/kubernetes-sigs/service-catalog/blob/master/charts/catalog-v0.2/templates/controller-manager-deployment.yaml)
348+
`fooEnabled` with a value of `false` in [values.yaml](https://github.com/kubernetes-sigs/service-catalog/blob/v0.2/charts/catalog-v0.2/values.yaml). In the [API Server](https://github.com/kubernetes-sigs/service-catalog/blob/v0.2/charts/catalog-v0.2/templates/apiserver-deployment.yaml) and [Controller](https://github.com/kubernetes-sigs/service-catalog/blob/v0.2/charts/catalog-v0.2/templates/controller-manager-deployment.yaml)
349349
templates, add the new FeatureGate:
350350
{% raw %}
351351
```yaml
@@ -355,7 +355,7 @@ templates, add the new FeatureGate:
355355
{% endraw %}
356356
357357
When the feature has had enough testing and the community agrees to change the
358-
default to true, update [features.go](https://github.com/kubernetes-sigs/service-catalog/blob/master/pkg/features/features.go) and `values.yaml` changing the default for
358+
default to true, update [features.go](https://github.com/kubernetes-sigs/service-catalog/blob/v0.2/pkg/features/features.go) and `values.yaml` changing the default for
359359
feature foo to `true`. And lastly update the appropriate information in the
360360
[FeatureGates doc](feature-gates.md).
361361

‎docs/install.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,9 @@ helm search service-catalog
114114
You should see the following output:
115115

116116
```console
117-
NAME VERSION DESCRIPTION
118-
svc-cat/catalog x,y.z service-catalog API server and controller-manag...
117+
NAME VERSION DESCRIPTION
118+
svc-cat-kyma/catalog 0.3.X service-catalog
119+
svc-cat-kyma/catalog-v0.2 0.2.X service-catalog API server ...
119120
```
120121

121122
## RBAC
@@ -167,7 +168,7 @@ Now that your cluster and Helm are configured properly, installing
167168
Service Catalog is simple:
168169

169170
```console
170-
helm install svc-cat/catalog \
171+
helm install svc-cat/catalog-v0.2 \
171172
--name catalog --namespace catalog
172173
```
173174

@@ -177,26 +178,19 @@ Follow the appropriate instructions for your operating system to install svcat.
177178
can be used by itself, or as a kubectl plugin.
178179

179180
The snippets below install the latest version of svcat. We also publish binaries for
180-
our canary (master) builds, and tags using the following prefixes:
181+
our canary (v0.2) builds, and tags using the following prefixes:
181182

182-
* Latest release: https://download.svcat.sh/cli/latest
183+
* Latest release: https://download.svcat.sh/cli/latest-v0.2
183184
* Tagged releases: https://download.svcat.sh/cli/VERSION
184-
where `VERSION` is the release, for example `v0.1.20`.
185-
* Canary builds: https://download.svcat.sh/cli/canary
185+
where `VERSION` is the release, for example `v0.2.3`.
186+
* Canary builds: https://download.svcat.sh/cli/canary-v0.2
186187
* Previous canary builds: https://download.svcat.sh/cli/VERSION-GITDESCRIBE
187-
where `GITDESCRIBE` is the result of calling `git describe --tags`, for example `v0.1.20-1-g203c8ad`.
188-
189-
## MacOS with Homebrew
190-
191-
```
192-
brew update
193-
brew install kubernetes-service-catalog-client
194-
```
188+
where `GITDESCRIBE` is the result of calling `git describe --tags`, for example `v0.2.3-1-g203c8ad`.
195189

196190
## MacOS
197191

198192
```
199-
curl -sLO https://download.svcat.sh/cli/latest/darwin/amd64/svcat
193+
curl -sLO https://download.svcat.sh/cli/latest-v0.2/darwin/amd64/svcat
200194
chmod +x ./svcat
201195
mv ./svcat /usr/local/bin/
202196
svcat version --client
@@ -205,7 +199,7 @@ svcat version --client
205199
## Linux
206200

207201
```
208-
curl -sLO https://download.svcat.sh/cli/latest/linux/amd64/svcat
202+
curl -sLO https://download.svcat.sh/cli/latest-v0.2/linux/amd64/svcat
209203
chmod +x ./svcat
210204
mv ./svcat /usr/local/bin/
211205
svcat version --client
@@ -217,7 +211,7 @@ The PowerShell snippet below adds a directory to your PATH for the current sessi
217211
You will need to find a permanent location for it and add it to your PATH.
218212

219213
```
220-
iwr 'https://download.svcat.sh/cli/latest/windows/amd64/svcat.exe' -UseBasicParsing -OutFile svcat.exe
214+
iwr 'https://download.svcat.sh/cli/latest-v0.2/windows/amd64/svcat.exe' -UseBasicParsing -OutFile svcat.exe
221215
mkdir -f ~\bin
222216
Move-Item -Path svcat.exe -Destination ~\bin
223217
$env:PATH += ";${pwd}\bin"
@@ -226,9 +220,9 @@ svcat version --client
226220

227221
## Manual
228222
1. Download the appropriate binary for your operating system:
229-
* macOS: https://download.svcat.sh/cli/latest/darwin/amd64/svcat
230-
* Windows: https://download.svcat.sh/cli/latest/windows/amd64/svcat.exe
231-
* Linux: https://download.svcat.sh/cli/latest/linux/amd64/svcat
223+
* macOS: https://download.svcat.sh/cli/latest-v0.2/darwin/amd64/svcat
224+
* Windows: https://download.svcat.sh/cli/latest-v0.2/windows/amd64/svcat.exe
225+
* Linux: https://download.svcat.sh/cli/latest-v0.2/linux/amd64/svcat
232226
1. Make the binary executable.
233227
1. Move the binary to a directory on your PATH.
234228

‎docs/resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The Service Catalog resource model specifies all the behaviors that
99
Service Catalog supports. This document details each resource.
1010

1111
All of these resources are also defined in Go code at
12-
[`pkg/apis/servicecatalog/v1beta1/types.go`](https://github.com/kubernetes-sigs/service-catalog/blob/master/pkg/apis/servicecatalog/v1beta1/types.go).
12+
[`pkg/apis/servicecatalog/v1beta1/types.go`](https://github.com/kubernetes-sigs/service-catalog/blob/v0.2/pkg/apis/servicecatalog/v1beta1/types.go).
1313

1414

1515
## Service Brokers

0 commit comments

Comments
 (0)