Skip to content

Commit b6d9de0

Browse files
edits
1 parent 1ad4405 commit b6d9de0

File tree

2 files changed

+27
-29
lines changed

2 files changed

+27
-29
lines changed

kubernetes/samples/scripts/elasticsearch-and-kibana/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
# Sample to deploy Elasticsearch and Kibana
22

33

4-
When a user installs the WebLogic operator Helm chart, the user can set
5-
`elkIntegrationEnabled` to `true` in their `values.yaml` to tell the operator to send the
6-
contents of the operator's logs to Elasticsearch.
4+
When you install the WebLogic operator Helm chart, you can set
5+
`elkIntegrationEnabled` to `true` in your `values.yaml` file to tell the operator to send the contents of the operator's logs to Elasticsearch.
76

8-
Typically, a user would have already configured Elasticsearch and Kibana in the
9-
Kubernetes cluster, and also would specify `elasticSearchHost` and `elasticSearchPort`
10-
in their `values.yaml` file to point to where Elasticsearch is already running.
7+
Typically, you would have already configured Elasticsearch and Kibana in the
8+
Kubernetes cluster, and also would have specified `elasticSearchHost` and `elasticSearchPort` in your `values.yaml` file to point to where Elasticsearch is already running.
119

1210
This sample configures the Elasticsearch and Kibana deployments and services.
1311
It's useful for trying out the operator in a Kubernetes cluster that doesn't already
1412
have them configured.
1513

16-
It runs Elasticstack on the same host and port that the operator's Helm chart defaults
17-
to, therefore, the customer only needs to set `elkIntegrationEnabled` to `true` in their
14+
It runs the Elastic Stack on the same host and port that the operator's Helm chart defaults
15+
to, therefore, you only need to set `elkIntegrationEnabled` to `true` in your
1816
`values.yaml` file.
1917

20-
To install ElasticSearch and Kibana, use:
18+
To install Elasticsearch and Kibana, use:
2119
```
2220
$ kubectl apply -f kubernetes/samples/scripts/elasticsearch-and-kibana/elasticsearch_and_kibana.yaml
2321
```

site/helm-charts.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44

55
The WebLogic Kubernetes Operator uses Helm to create and deploy any necessary resources and then run the operator in a Kubernetes cluster. Helm helps you manage Kubernetes applications. Helm charts help you define and install applications into the Kubernetes cluster. The operator's Helm chart is located in the `kubernetes/charts/weblogic-operator` directory.
66

7-
> If you have an old version of the operator installed on your cluster you must remove
8-
it before installing this version. You should remove the deployment (for example `kubectl delete deploy weblogic-operator -n your-namespace`) and the custom
9-
resource definition (for example `kubectl delete crd domain`). If you do not remove
10-
the custom resource definition you may see errors like this:
11-
12-
`Error from server (BadRequest): error when creating "/scratch/output/uidomain/weblogic-domains/uidomain/domain.yaml":
7+
> If you have an older version of the operator installed on your cluster, then you must remove
8+
it before installing this version. You should remove the deployment (for example, `kubectl delete deploy weblogic-operator -n your-namespace`) and the custom
9+
resource definition (for example, `kubectl delete crd domain`). If you do not remove
10+
the custom resource definition, then you might see errors like this:
11+
12+
`Error from server (BadRequest): error when creating "/scratch/output/uidomain/weblogic-domains/uidomain/domain.yaml":
1313
the API version in the data (weblogic.oracle/v2) does not match the expected API version (weblogic.oracle/v1`
1414

1515

1616
## Install Helm and Tiller
1717

18-
Helm has two parts: a client (helm) and a server (tiller). Tiller runs inside of your Kubernetes cluster, and manages releases (installations) of your charts. See https://github.com/kubernetes/helm/blob/master/docs/install.md for detailed instructions on installing helm and tiller.
18+
Helm has two parts: a client (Helm) and a server (Tiller). Tiller runs inside of your Kubernetes cluster, and manages releases (installations) of your charts. See https://github.com/kubernetes/helm/blob/master/docs/install.md for detailed instructions on installing Helm and Tiller.
1919

2020
## Operator's Helm chart configuration
2121

@@ -69,7 +69,7 @@ You are responsible for configuring Kibana and Elasticsearch, then configuring t
6969
As part of the ELK integration, Logstash configuration occurs for each deployed operator instance. You can use the following configuration values to configure the integration:
7070

7171
* Set `elkIntegrationEnabled` is `true` to enable the integration.
72-
* Set `logStashImage` to override the default version of logstash to be used (`logstash:6.2`).
72+
* Set `logStashImage` to override the default version of Logstash to be used (`logstash:6.2`).
7373
* Set `elasticSearchHost` and `elasticSearchPort` to override the default location where Elasticsearch is running (`elasticsearch2.default.svc.cluster.local:9201`). This will configure Logstash to send the operator's log contents there.
7474

7575
More detailed information about configuration values can be found in [Operator Helm configuration values](#operator-helm-configuration-values).
@@ -146,7 +146,7 @@ Show the history of the operator Helm release:
146146
$ helm history weblogic-operator
147147
```
148148

149-
Roll back to a previous version of this operator Helm release, in this case the first version:
149+
Roll back to a previous version of this operator Helm release, in this case, the first version:
150150
```
151151
$ helm rollback weblogic-operator 1
152152
```
@@ -226,7 +226,7 @@ imagePullSecrets:
226226

227227
#### `domainNamespaces`
228228

229-
Specifies a list of WebLogic domain namespaces which the operator manages. The names must be lower case. You are responsible for creating these namespace.
229+
Specifies a list of WebLogic domain namespaces which the operator manages. The names must be lower case. You are responsible for creating these namespaces.
230230

231231
This property is required.
232232

@@ -297,7 +297,7 @@ Determines whether the operator's REST interface will be exposed outside the Kub
297297

298298
Defaults to `false`.
299299

300-
If set to true, the user must provide the SSL certificate and private key for the operator's external REST interface by specifying the `externalOperatorCert` and `externalOperatorKey` properties.
300+
If set to `true`, you must provide the SSL certificate and private key for the operator's external REST interface by specifying the `externalOperatorCert` and `externalOperatorKey` properties.
301301

302302
Example:
303303
```
@@ -318,11 +318,11 @@ externalRestHttpsPort: 32009
318318

319319
#### externalOperatorCert
320320

321-
Specifies the user supplied certificate to use for the external operator REST HTTPS interface. The value must be a string containing a Base64 encoded PEM certificate. This parameter is required if `externalRestEnabled` is true, otherwise, it is ignored.
321+
Specifies the user supplied certificate to use for the external operator REST HTTPS interface. The value must be a string containing a Base64 encoded PEM certificate. This parameter is required if `externalRestEnabled` is `true`, otherwise, it is ignored.
322322

323323
There is no default value.
324324

325-
The helm installation will produce an error, similar to the following, if `externalOperatorCert` is not specified (left blank) and `externalRestEnabled` is true:
325+
The Helm installation will produce an error, similar to the following, if `externalOperatorCert` is not specified (left blank) and `externalRestEnabled` is `true`:
326326
```
327327
Error: render error in "weblogic-operator/templates/main.yaml": template: weblogic-operator/templates/main.yaml:4:3: executing "weblogic-operator/templates/main.yaml"
328328
at <include "operator.va...>: error calling include: template: weblogic-operator/templates/_validate-inputs.tpl:53:4: executing "operator.validateInputs"
@@ -341,7 +341,7 @@ Specifies user supplied private key to use for the external operator REST HTTPS
341341

342342
There is no default value.
343343

344-
The helm installation will produce an error, similar to the following, if `externalOperatorKey` is not specified (left blank) and `externalRestEnabled` is true:
344+
The Helm installation will produce an error, similar to the following, if `externalOperatorKey` is not specified (left blank) and `externalRestEnabled` is `true`:
345345
```
346346
Error: render error in "weblogic-operator/templates/main.yaml": template: weblogic-operator/templates/main.yaml:4:3: executing "weblogic-operator/templates/main.yaml"
347347
at <include "operator.va...>: error calling include: template: weblogic-operator/templates/_validate-inputs.tpl:53:4: executing "operator.validateInputs"
@@ -438,13 +438,13 @@ The `helm upgrade` succeeds, and silently adopts the resources the first operato
438438

439439
For example, if you delete this release, then the first operator will get messed up because the role binding it needs is gone. The big problem is that you don't get a warning, so you don't know that there's a problem to fix.
440440

441-
This can be fixed by just upgrading the helm release.
441+
This can be fixed by just upgrading the Helm release.
442442

443-
This may also be fixed by rolling back the helm release.
443+
This may also be fixed by rolling back the Helm release.
444444

445445
### Installing an operator and telling it to use the same external REST port number as another operator
446446

447-
A new `FAILED` helm release is created.
447+
A new `FAILED` Helm release is created.
448448
```
449449
$ helm install --no-hooks --name op2 --namespace myuser-op2-ns --values o.yaml kubernetes/charts/weblogic-operator
450450
Error: release op2 failed: Service "external-weblogic-operator-svc" is invalid: spec.ports[0].nodePort: Invalid value: 31023: provided port is already allocated
@@ -462,8 +462,8 @@ $ helm upgrade --no-hooks --values o23.yaml op2 kubernetes/charts/weblogic-opera
462462
Error: UPGRADE FAILED: Service "external-weblogic-operator-svc" is invalid: spec.ports[0].nodePort: Invalid value: 31023: provided port is already allocated
463463
```
464464

465-
You can fix this by upgrading the helm release (to fix the port number).
466-
You can also fix this by rolling back the helm release.
465+
You can fix this by upgrading the Helm release (to fix the port number).
466+
You can also fix this by rolling back the Helm release.
467467

468468
### Installing an operator and telling it to use a service account that doesn't exist
469469

@@ -503,7 +503,7 @@ To recover:
503503

504504
### Installing an operator and telling it to manage a domain namespace that doesn't exist
505505

506-
A new 'FAILED' helm release is created.
506+
A new `FAILED` Helm release is created.
507507
```
508508
$ helm install --no-hooks --name op2 --namespace myuser-op2-ns --values o.yaml kubernetes/charts/weblogic-operator
509509
Error: release op2 failed: namespaces "myuser-d2-ns" not found

0 commit comments

Comments
 (0)