Skip to content

Commit f23a844

Browse files
authored
Merge pull request #67 from 3scale/fix-tenant-doc
fix tenant doc
2 parents cc41075 + 4b607f0 commit f23a844

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

doc/api-crd-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ CRD Diagram:
6969

7070
### Tenant Secret
7171

72-
The credentials are typically provided by the [Tenant Controller](/doc/tenant-crd-reference.md)
72+
The credentials are typically provided by the [Tenant Controller](/doc/tenant-reference.md)
7373
and stored in a secret, defined by the tenant CR.
7474

7575
But this Secret can also be created by the user following this schema:

doc/user-guide.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,24 @@ solution in the "operator-test" project
178178
Deploying the *APIManager* custom resource (see section above) creates a default tenant.
179179
Optionally, you may create other tenants deploying **Tenant custom resource** objects.
180180

181-
To deploy a new tenant in your 3scale instance, create a new YAML file with the following content:
181+
To deploy a new tenant in your 3scale instance, first, create secret to store admin password:
182+
183+
```sh
184+
$ cat ecorp-admin-secret.yaml
185+
apiVersion: v1
186+
kind: Secret
187+
metadata:
188+
name: ecorp-admin-secret
189+
type: Opaque
190+
stringData:
191+
admin_password: <admin password value>
192+
193+
194+
$ oc create -f ecorp-admin-secret.yaml
195+
secret/ecorp-admin-secret created
196+
```
197+
198+
then, create a new Tenant CR YAML file with the following content:
182199

183200
```yaml
184201
apiVersion: capabilities.3scale.net/v1alpha1
@@ -201,7 +218,7 @@ spec:
201218

202219
To look at more information on what the Tenant Custom Resource fields and
203220
possible values are refer to
204-
the [Tenant CRD Reference](tenant-crd-reference.md) documentation.
221+
the [Tenant CRD Reference](tenant-reference.md) documentation.
205222

206223
```sh
207224
export NAMESPACE="operator-test"
@@ -266,7 +283,7 @@ spec:
266283
267284
In all the Selectors (metric, plan, mappingrules...) we use a specific label "api: api01", you can change that and add as many labels and play with the selectors to cover really complex scenarios.
268285
269-
We should add a Plan:
286+
We should add a Plan:
270287
271288
```yaml
272289
apiVersion: capabilities.3scale.net/v1alpha1
@@ -303,7 +320,7 @@ spec:
303320
304321
```
305322
306-
A simple limit with a limit of 10 hits per day for the previous metric:
323+
A simple limit with a limit of 10 hits per day for the previous metric:
307324
308325
```yaml
309326
apiVersion: capabilities.3scale.net/v1alpha1
@@ -356,7 +373,7 @@ As you can see, the binding object will reference the `ecorp-tenant-secret` and
356373
Now, navigate to your new created 3scale Tenant, and check that everything has been created!
357374
358375
For more information, check the reference doc: [Capabilities CRD Reference](api-crd-reference.md)
359-
376+
360377
## Cleanup
361378
362379
Delete the created custom resources:

0 commit comments

Comments
 (0)