Skip to content

Commit a3223e7

Browse files
authored
Doc 6 (#654)
* udpate install doc to reference richard's helm doc * update toc * tidying up the toc
1 parent 6d5c03a commit a3223e7

File tree

2 files changed

+26
-19
lines changed

2 files changed

+26
-19
lines changed

site/install.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@
33

44
## Create and manage the operator
55

6-
An operator is an application-specific controller that extends Kubernetes to create, configure, and manage instances of complex applications. The WebLogic Kubernetes Operator follows the standard Kubernetes Operator pattern, and simplifies the management and operation of WebLogic domains and deployments. You can find the operator image in [Docker Hub](https://hub.docker.com/r/oracle/weblogic-kubernetes-operator/).
6+
An operator is an application-specific controller that extends Kubernetes to create, configure, and manage instances
7+
of complex applications. The Oracle WebLogic Server Kubernetes Operator follows the standard Kubernetes operator pattern, and
8+
simplifies the management and operation of WebLogic domains and deployments.
79

8-
In your Kubernetes cluster you can have one or more operators that manage one or more WebLogic domains (running in a cluster). We provide a Helm chart to create the operator. (Point to the documentation and sample that describes how to do the steps below.)
910

11+
You can have one or more operators in your Kubernetes cluster that manage one or more WebLogic domains each.
12+
We provide a Helm chart to manage the installation and configuration of the operator and that is the
13+
*preferred method* of managing operators. Detailed instructions are available [here](helm-charts.md).
1014

11-
### Starting the operator
15+
If, for some reason, you do not want to use Helm, it is still possible to perform a manual
16+
installation of the operator. This is *not the recommended approach*, but is fully [documented here](manual-installation.md)
17+
if you wish to use this approach.
1218

13-
* Create the namespace and service account for the operator (See the script and doc that describe how to do these.)
14-
* Edit the operator input YAML
15-
* Start the operator with a Helm chart
19+
### Operator Docker image
1620

17-
### Modifying the operator
18-
19-
(images, RBAC roles, ...)
20-
21-
### Shutting down the operator
22-
(See the operator sample README section that describes how to shutdown and delete all resources for the operator.)
21+
You can find the operator image in
22+
[Docker Hub](https://hub.docker.com/r/oracle/weblogic-kubernetes-operator/).
2323

site/user-guide.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
# User Guide
22

3-
**TOOO** put intro here
3+
This document provides detailed information that is targeted at the user of the Oracle WebLogic
4+
Server Kubernetes Operator. It provides instructions on how to install the operator in your
5+
Kubernetes cluster and how to use it to manage WebLogic domains.
6+
7+
If you are looking for information about how the operator is designed, implemented, built, etc., then
8+
you should refer to the [Developer guide](developer.md).
49

510
## Table of contents
611

7-
**TODO** this is not the final TOC - we will restructure/reorganize for usability....
12+
The information in this guide is organized in the order that you would most likely need to use it. If you
13+
want to set up an operator and use it to create and manage WebLogic domains, you should
14+
follow this guide from top to bottom, and the necessary information will be
15+
presented in the correct order.
816

917
* [Important terms](#important-terms)
1018
* [Getting started](#getting-started)
1119
* [Prerequisites](#prerequisites)
12-
* [Preparing your Kubernetes environment](prepare-k8s.md)
20+
* [Preparing your Kubernetes environment to run the operator](prepare-k8s.md)
1321
* [Set up your Kubernetes cluster](prepare-k8s.md#set-up-your-kubernetes-cluster)
1422
* [Set up load balancers](load-balancing.md)
1523
* [Configuring Kibana and Elasticsearch](prepare-k8s.md#configuring-kibana-and-elasticsearch)
16-
* [Create and manage the operator](install.md)
17-
* [Starting the operator](install.md#starting-the-operator)
18-
* [Modifying the operator](install.md#modifying-the-operator)
19-
* [Shutting down the operator](install.md#shutting-down-the-operator)
24+
* [Install and manage the operator](install.md)
25+
* [Using the Helm charts](helm-charts.md) is the *preferred* method
26+
* [Manual installation](manual-installation.md) is also possible
2027
* [Creating or obtaining WebLogic Docker images](weblogic-docker-images.md)
2128
* [Obtaining standard images from the Docker store](weblogic-docker-images.md#obtaining-standard-images-from-the-docker-store)
2229
* [Creating a custom images with patches applied](weblogic-docker-images.md#creating-a-custom-images-with-patches-applied)

0 commit comments

Comments
 (0)