Skip to content

Commit 5d9906f

Browse files
committed
Merge branch 'develop' of https://github.com/oracle/weblogic-kubernetes-operator into feature-version
2 parents 994de44 + b9972a2 commit 5d9906f

File tree

4 files changed

+60
-60
lines changed

4 files changed

+60
-60
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Please refer to [Shutting down a domain](site/shutdown-domain.md) for informatio
161161

162162
## Load balancing with an Ingress controller or a web server
163163

164-
You can choose a load balancer provider for your WebLogic domains running in a Kubernetes cluster. Please refer to Load balancing with Voyager Ingress Controller, [Load balancing with Traefik Ingress Controller](site/traefik.md), and [Load balancing with Apache Web Server](site/apache.md) for information about the current capabilities and setup instructions for each of the supported load balancers.
164+
You can choose a load balancer provider for your WebLogic domains running in a Kubernetes cluster. Please refer to Load balancing with Voyager Ingress Controller, [Load balancing with Traefik Ingress Controller](site/traefik.md), and [Load balancing with Apache HTTP Server](site/apache.md) for information about the current capabilities and setup instructions for each of the supported load balancers.
165165

166166

167167
[comment]: # (Exporting operator logs to ELK. The operator provides an option to export its log files to the ELK stack. Please refer to [ELK integration]site/elk.md for information about this capability.)

site/k8s_setup.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ If you need some help setting up a Kubernetes environment to experiment with the
1111

1212
* Set up your own Kubernetes environment on bare compute resources on a cloud.
1313
* Use you cloud provider's management console to provision a managed Kubernetes environment.
14-
* Install Kubernetes on your own compute resources (i.e. "real" computers, outside a cloud).
14+
* Install Kubernetes on your own compute resources (for example, "real" computers, outside a cloud).
1515

1616
"Development/test" options:
1717

1818
* Install [Docker for Mac](https://docs.docker.com/docker-for-mac/#kubernetes) and enable its embedded Kubernetes cluster (or register for the [Docker for Windows](https://beta.docker.com/form) beta and wait until Kubernetes is available there).
1919
* Install [Minikube](https://github.com/kubernetes/minikube) on your Windows/Linux/Mac computer.
2020

21-
We have provided our hints and tips for several of these options in the sections below:
21+
We have provided our hints and tips for several of these options in the sections below.
2222

2323
## Set up Kubernetes on bare compute resources in a cloud
2424

25-
Follow the basic steps from the [Terraform Kubernetes installer for Oracle Cloud Infrastructure](https://github.com/oracle/terraform-kubernetes-installer):
25+
Follow the basic steps from the [Terraform Kubernetes installer for Oracle Cloud Infrastructure](https://github.com/oracle/terraform-kubernetes-installer).
2626

2727
### Prerequisites
2828

@@ -34,7 +34,7 @@ providers {
3434
oci = "<path_to_provider_binary>/terraform-provider-oci"
3535
}
3636
```
37-
4. Ensure you have [Kubectl][Kubectl] installed if you plan to interact with the cluster locally.
37+
4. Ensure that you have [Kubectl][Kubectl] installed if you plan to interact with the cluster locally.
3838

3939
### Quick Start
4040

@@ -50,13 +50,13 @@ cd terraform-kubernetes-installer
5050
terraform init
5151
```
5252

53-
3. Copy the example terraform.tvfars:
53+
3. Copy the example `terraform.tvfars`:
5454

5555
```
5656
cp terraform.example.tfvars terraform.tfvars
5757
```
5858

59-
4. Edit the `terraform.tvfars` file to include values for your tenancy, user, and compartment. Optionally edit variables to change the `Shape` of the VMs for your Kubernetes master and workers, and your etcd cluster. For example:
59+
4. Edit the `terraform.tvfars` file to include values for your tenancy, user, and compartment. Optionally, edit variables to change the `Shape` of the VMs for your Kubernetes master and workers, and your `etcd` cluster. For example:
6060

6161
```
6262
#give a label to your cluster to help identify it if you have multiple
@@ -138,20 +138,20 @@ $
138138
```
139139

140140

141-
## Install Kubernetes on your own compute resources (e.g. Oracle Linux servers outside a cloud)
141+
## Install Kubernetes on your own compute resources (for example, Oracle Linux servers outside a cloud)
142142

143-
These instructions are for Oracle Linux 7u2+. If you are using a different flavor of Linux, you will need to adjust accordingly.
143+
These instructions are for Oracle Linux 7u2+. If you are using a different flavor of Linux, you will need to adjust them accordingly.
144144

145-
**NOTE** These steps must be run with the `root` user, until specified otherwise! Any time you see `YOUR_USERID` in a command, you should replace it with your actual userid.
145+
**NOTE**: These steps must be run with the `root` user, until specified otherwise! Any time you see `YOUR_USERID` in a command, you should replace it with your actual `userid`.
146146

147-
Choose the directories where your Docker and Kubernetes files will be stored. The Docker directory should be on a disk with a lot of free space (more than 100GB) because it will be used for the `/var/lib/docker` file syste, which contains all of your images and containers. The Kubernetes directory will be used for the `/var/lib/kubelet` file system and persistent volume storage.
147+
Choose the directories where your Docker and Kubernetes files will be stored. The Docker directory should be on a disk with a lot of free space (more than 100GB) because it will be used for the `/var/lib/docker` file system, which contains all of your images and containers. The Kubernetes directory will be used for the `/var/lib/kubelet` file system and persistent volume storage.
148148

149149
```
150150
export docker_dir=/scratch/docker
151151
export k8s_dir=/scratch/k8s_dir
152152
```
153153

154-
Create a shell script that sets up the necessary environment variables. You should probably just append this to the user's `.bashrc` so that it will get executed at login. You will also need to configure your proxy settings in here if you are behind an HTTP proxy:
154+
Create a shell script that sets up the necessary environment variables. You should probably just append this to the user's `.bashrc` so that it will get executed at login. You will also need to configure your proxy settings here if you are behind an HTTP proxy:
155155

156156
```
157157
export PATH=$PATH:/sbin:/usr/sbin
@@ -186,14 +186,14 @@ If you want command completion, you can add the following to the script:
186186
source <(kubectl completion bash)
187187
```
188188

189-
Create the directories we need:
189+
Create the directories you need:
190190

191191
```
192192
mkdir -p $docker_dir $k8s_dir/kubelet
193193
ln -s $k8s_dir/kubelet /var/lib/kubelet
194194
```
195195

196-
Set an environment variable with the Docker version we want to install:
196+
Set an environment variable with the Docker version you want to install:
197197

198198
```
199199
docker_version="17.03.1.ce"
@@ -219,7 +219,7 @@ diff /etc/sysconfig/docker /tmp/docker.out
219219
mv /tmp/docker.out /etc/sysconfig/docker
220220
```
221221

222-
Set up the Docker network, including the HTTP proxy configuration if you need it:
222+
Set up the Docker network, including the HTTP proxy configuration, if you need it:
223223

224224
```
225225
# generate a custom /setc/sysconfig/docker-network
@@ -238,7 +238,7 @@ Add your user to the `docker` group:
238238
usermod -aG docker YOUR_USERID
239239
```
240240

241-
Enable and start the Docker service that we just installed and configured:
241+
Enable and start the Docker service that you just installed and configured:
242242

243243
```
244244
systemctl enable docker && systemctl start docker
@@ -314,7 +314,7 @@ chown YOUR_USERID:YOUR_GROUP $KUBECONFIG
314314
chmod 644 $KUBECONFIG
315315
```
316316

317-
**NOTE** The following steps should be run with your normal (non-`root`) user.
317+
**NOTE**: The following steps should be run with your normal (non-`root`) user.
318318

319319
Configure CNI:
320320

@@ -357,7 +357,7 @@ Congratulations! Docker and Kubernetes are installed and configured!
357357

358358
## Install Docker for Mac with Kubernetes
359359

360-
Docker for Mac 17.12 CE Edge provides an [embedded Kubernetes environment](https://docs.docker.com/docker-for-mac/#kubernetes) that is a pretty quick and easy way to get a simple test environment set up on your Mac. To set it up, follow these instructions:
360+
Docker for Mac 17.12 CE Edge provides an [embedded Kubernetes environment](https://docs.docker.com/docker-for-mac/#kubernetes) that is a quick and easy way to get a simple test environment set up on your Mac. To set it up, follow these instructions:
361361

362362
Install "Docker for Mac" from the Edge channel [https://download.docker.com/mac/edge/Docker.dmg](https://download.docker.com/mac/edge/Docker.dmg). Then start up the Docker application (press Command-Space bar, type in `Docker` and run it). After it is running you will see the Docker icon appear in your status bar:
363363

@@ -371,7 +371,7 @@ Go to the "Kubernetes" tab and click on the option to enable Kubernetes:
371371

372372
![Enable Kubernetes setting](images/docker-enable-k8s.png)
373373

374-
**Note** If you are behind an HTTP proxy, then you should also go to the "Proxies" tab and enter your proxy details.
374+
**Note**: If you are behind an HTTP proxy, then you should also go to the "Proxies" tab and enter your proxy details.
375375

376376
Docker will download the Kuberentes components and start them up for you. When it is done, you will see the Kubernetes status go to green/running in the menu:
377377

site/manually-creating-domain.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Manually creating a WebLogic domain
22

3-
**PLEASE NOTE** This page is a work in progress, we have some rough notes in here, we are working on writing better doc for how to set up this integration.
3+
**PLEASE NOTE**: This page is a work in progress. We have some rough notes here and are working on writing better documentation for how to set up this procedure.
44

5-
If creating the domain manually, using a WLST script for example, the domain must be configured to meet these requirements:
5+
If you are creating the domain manually, for example, using a WLST script, the domain must be configured to meet these requirements:
66

77
* Domain directory should be in `/shared/domain`.
88
* Applications directory should be in `/shared/applications`.
@@ -11,11 +11,11 @@ If creating the domain manually, using a WLST script for example, the domain mus
1111

1212
## Use the scripts to create the sample YAML files
1313

14-
The `create-weblogic-domain.sh` script described in the previous section can be executed with the “-g” option, which will cause it to generate the YAML files but take no action at all against the Kubernetes environment. This is a useful way to create the sample YAML files needed to manually create a domain.
14+
The `create-weblogic-domain.sh` script can be executed with the `-g` option, which will cause it to generate the YAML files but take no action at all against the Kubernetes environment. This is a useful way to create the sample YAML files needed to manually create a domain.
1515

1616
First, make a copy of `create-weblogic-domain-inputs.yaml` and customize it.
1717

18-
Next, choose and create a directory that generated operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
18+
Next, choose and create a directory that generated operator-related files will be stored in, for example, `/path/to/weblogic-operator-output-directory`.
1919

2020
Then, execute the script, pointing it at your inputs file and output directory:
2121

@@ -25,7 +25,7 @@ Then, execute the script, pointing it at your inputs file and output directory:
2525
-o /path/to/weblogic-operator-output-directory
2626
```
2727

28-
The following YAML files will be generated in the /path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID> directory:
28+
The following YAML files will be generated in the `/path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>` directory:
2929

3030
* `weblogic-domain-pv.yaml` can be customized and used to create the persistent volume for this domain.
3131
* `weblogic-domain-pvc.yaml` can be customized and used to create the persistent volume claim for this domain.
@@ -48,13 +48,13 @@ The file `weblogic-domain-pv.yaml` contains a template to create a persistent vo
4848
* Persistent volume name
4949
* Storage class name
5050
* The amount of storage to allocate
51-
* The physical location of the persistent volume (edit). Prior to creating the persistent volume you need to ensure this location exists and has read/write/execute permission set for the account that Kubernetes is running from.
51+
* The physical location of the persistent volume (edit). Prior to creating the persistent volume, you need to ensure this location exists and has read/write/execute permissions set for the account that Kubernetes is running from.
5252
* The access mode is Read/Write Many. You must use a provider that supports Read/Write Many.
5353
* The contents of the volume are retained across restarts of the Kubernetes environment.
5454

5555
## Creating the persistent volume
5656

57-
To create the persistent volume issue the following command:
57+
To create the persistent volume, issue the following command:
5858

5959
```
6060
kubectl create –f weblogic-domain-pv.yaml
@@ -70,7 +70,7 @@ Replace `PV_NAME` with the name of the persistent volume.
7070

7171
## Preparing to create the persistent volume claim
7272

73-
The file `weblogic-domain-pvc.yaml` contains a template to claim a portion of the persistent volume storage. The customizable items are listed below:
73+
The file, `weblogic-domain-pvc.yaml`, contains a template to claim a portion of the persistent volume storage. The customizable items are:
7474

7575
* Persistent volume claim name
7676
* Namespace name
@@ -80,7 +80,7 @@ The file `weblogic-domain-pvc.yaml` contains a template to claim a portion of th
8080

8181
## Creating the persistent volume claim
8282

83-
To create the persistent volume claim issue the following command:
83+
To create the persistent volume claim, issue the following command:
8484

8585
```
8686
kubectl create –f weblogic-domain-pvc.yaml
@@ -96,7 +96,7 @@ Replace `PVC_NAME` with the name of the persistent volume claim.
9696

9797
## Preparing to create the domain custom resource
9898

99-
The file `domain-custom-resource.yaml` contains a template to create the domain custom resource. The customizable items are listed below:
99+
The file, `domain-custom-resource.yaml`, contains a template to create the domain custom resource. The customizable items are:
100100

101101
* Domain name
102102
* Namespace name

0 commit comments

Comments
 (0)