|
| 1 | +### Oracle WebLogic Server Kubernetes Operator |
| 2 | + |
| 3 | +Oracle is finding ways for organizations using WebLogic Server to run important workloads, to move those workloads into the cloud. By certifying on industry standards, such as Docker and Kubernetes, WebLogic now runs in a cloud neutral infrastructure. In addition, we've provided an open-source Oracle WebLogic Server Kubernetes Operator (the “operator”) which has several key features to assist you with deploying and managing WebLogic domains in a Kubernetes environment. You can: |
| 4 | + |
| 5 | +* Create WebLogic domains in a Kubernetes persistent volume. This persistent volume can reside in an NFS file system or other Kubernetes volume types. |
| 6 | +* Create a WebLogic domain in a Docker image. |
| 7 | +* Override certain aspects of the WebLogic domain configuration. |
| 8 | +* Define WebLogic domains as a Kubernetes resource (using a Kubernetes custom resource definition). |
| 9 | +* Start servers based on declarative startup parameters and desired states. |
| 10 | +* Manage WebLogic configured or dynamic clusters. |
| 11 | +* Expose the WebLogic Server Administration Console outside the Kubernetes cluster, if desired. |
| 12 | +* Expose T3 channels outside the Kubernetes domain, if desired. |
| 13 | +* Expose HTTP paths on a WebLogic domain outside the Kubernetes domain with load balancing and update the load balancer when Managed Servers in the WebLogic domain are started or stopped. |
| 14 | +* Scale WebLogic domains by starting and stopping Managed Servers on demand, or by integrating with a REST API to initiate scaling based on WLDF, Prometheus, Grafana, or other rules. |
| 15 | +* Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana. |
| 16 | + |
| 17 | +The fastest way to experience the operator is to follow the [Quick Start guide]({{< relref "/quickstart/_index.md" >}}), or you can peruse our [documentation]({{< relref "/userguide/_index.md" >}}), read our [blogs](https://blogs.oracle.com/weblogicserver/updated-weblogic-kubernetes-support-with-operator-20), or try out the [samples]({{< relref "/samples/_index.md" >}}). |
| 18 | + |
| 19 | +*** |
| 20 | +The [current release of the operator](https://github.com/oracle/weblogic-kubernetes-operator/releases) is 2.0.1. |
| 21 | +This release was published on March 4, 2019. |
| 22 | +*** |
| 23 | + |
| 24 | +#### Operator earlier versions |
| 25 | + |
| 26 | +Documentation for prior releases of the operator is available [here](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/site/README.md). |
| 27 | + |
| 28 | +#### Backward compatibility guidelines |
| 29 | + |
| 30 | +Starting from the 2.0.1 release, operator releases are backward compatible with respect to the domain |
| 31 | +resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created |
| 32 | +by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We intend to |
| 33 | +maintain compatibility for three releases, except in the case of a clearly communicated deprecated feature, which will be |
| 34 | +maintained for one release after a replacement is available. |
| 35 | + |
| 36 | +### About this documentation |
| 37 | + |
| 38 | +This documentation includes sections targeted to different audiences. To help you find what you are looking for more easily, |
| 39 | +please consult this table of contents: |
| 40 | + |
| 41 | +* The [Quick Start guide]({{< relref "/quickstart/_index.md" >}}) explains how to quickly get the operator running, using the defaults, nothing special. |
| 42 | +* The [User guide]({{< relref "/userguide/_index.md" >}}) contains detailed usage information, including how to install and configure the operator, |
| 43 | + and how to use it to create and manage WebLogic domains. |
| 44 | +* The [Samples]({{< relref "/samples/_index.md" >}}) provide detailed example code and instructions that show you how to perform |
| 45 | + various tasks related to the operator. |
| 46 | +* The [Developer guide]({{< relref "/developerguide/_index.md" >}}) provides details for people who want to understand how the operator is built, tested, and so on. Those who wish to contribute to the operator code will find useful information here. This section also includes |
| 47 | + API documentation (Javadoc) and Swagger/OpenAPI documentation for the REST APIs. |
| 48 | +* The [Contributing](#contributing-to-the-operator) section provides information about contribution requirements. |
| 49 | + |
| 50 | + |
| 51 | +### User guide |
| 52 | + |
| 53 | +The [User guide]({{< relref "/userguide/_index.md" >}}) provides detailed information about all aspects of using the operator including: |
| 54 | + |
| 55 | +* Installing and configuring the operator. |
| 56 | +* Using the operator to create and manage WebLogic domains. |
| 57 | +* Manually creating WebLogic domains to be managed by the operator. |
| 58 | +* Scaling WebLogic clusters. |
| 59 | +* Configuring Kubernetes load balancers. |
| 60 | +* Configuring Elasticsearch and Kibana to access the operator's log files. |
| 61 | +* Shutting down domains. |
| 62 | +* Removing/deleting domains. |
| 63 | +* And much more! |
| 64 | + |
| 65 | +### Samples |
| 66 | + |
| 67 | +Please refer to our [samples]({{< relref "/samples/_index.md" >}}) for information about the available sample code. |
| 68 | + |
| 69 | +### Need more help? Have a suggestion? Come and say, "Hello!" |
| 70 | + |
| 71 | +We have a **public Slack channel** where you can get in touch with us to ask questions about using the operator or give us feedback |
| 72 | +or suggestions about what features and improvements you would like to see. We would love to hear from you. To join our channel, |
| 73 | +please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/). The invitation email will include |
| 74 | +details of how to access our Slack workspace. After you are logged in, please come to `#operator` and say, "hello!" |
| 75 | + |
| 76 | +### Recent changes and known issues |
| 77 | + |
| 78 | +See the [Release Notes]({{< relref "release-notes.md" >}}) for recent changes to the operator and known issues. |
| 79 | + |
| 80 | +### Developer guide |
| 81 | + |
| 82 | +Developers interested in this project are encouraged to read the [Developer guide]({{< relref "/developerguide/_index.md" >}}) to learn how to build the project, run tests, and so on. The Developer guide also provides details about the structure of the code, coding standards, and the Asynchronous Call facility used in the code to manage calls to the Kubernetes API. |
| 83 | + |
| 84 | +Please take a look at our [wish list](https://github.com/oracle/weblogic-kubernetes-operator/wiki/Wish-list) to get an idea of the kind of features we would like to add to the operator. Maybe you will see something to which you would like to contribute! |
| 85 | + |
| 86 | +### API documentation |
| 87 | + |
| 88 | +Documentation for APIs: |
| 89 | + |
| 90 | +* The operator provides a REST API that you can use to obtain configuration information and to initiate scaling actions. For details about how to use the REST APIs, see [Use the operator's REST services]({{< relref "/userguide/managing-operators/using-the-operator/the-rest-api.md#use-the-operator-s-rest-services" >}}). |
| 91 | + |
| 92 | +* See the [Swagger](https://oracle.github.io/weblogic-kubernetes-operator/swagger/index.html) documentation for the operator's REST interface. |
| 93 | + |
| 94 | +* See the [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator. |
| 95 | + |
| 96 | +### Contributing to the operator |
| 97 | + |
| 98 | +Oracle welcomes contributions to this project from anyone. Contributions may be reporting an issue with the operator or submitting a pull request. Before embarking on significant development that may result in a large pull request, it is recommended that you create an issue and discuss the proposed changes with the existing developers first. |
| 99 | + |
| 100 | +If you want to submit a pull request to fix a bug or enhance an existing feature, please first open an issue and link to that issue when you submit your pull request. |
| 101 | + |
| 102 | +If you have any questions about a possible submission, feel free to open an issue too. |
| 103 | + |
| 104 | +#### Contributing to the Oracle WebLogic Server Kubernetes Operator repository |
| 105 | + |
| 106 | +Pull requests can be made under The Oracle Contributor Agreement (OCA), which is available at [https://www.oracle.com/technetwork/community/oca-486395.html](https://www.oracle.com/technetwork/community/oca-486395.html). |
| 107 | + |
| 108 | +For pull requests to be accepted, the bottom of the commit message must have the following line, using the contributor’s name and e-mail address as it appears in the OCA Signatories list. |
| 109 | + |
| 110 | +``` |
| 111 | +Signed-off-by: Your Name <[email protected]> |
| 112 | +``` |
| 113 | + |
| 114 | +This can be automatically added to pull requests by committing with: |
| 115 | + |
| 116 | +``` |
| 117 | +git commit --signoff |
| 118 | +``` |
| 119 | + |
| 120 | +Only pull requests from committers that can be verified as having signed the OCA can be accepted. |
| 121 | + |
| 122 | +#### Pull request process |
| 123 | + |
| 124 | +* Fork the repository. |
| 125 | +* Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, for example, `1234-fixes`. |
| 126 | +* Ensure that any documentation is updated with the changes that are required by your fix. |
| 127 | +* Ensure that any samples are updated if the base image has been changed. |
| 128 | +* Submit the pull request. Do not leave the pull request blank. Explain exactly what your changes are meant to do and provide simple steps on how to validate your changes. Ensure that you reference the issue you created as well. We will assign the pull request to 2-3 people for review before it is merged. |
| 129 | + |
| 130 | +#### Introducing a new dependency |
| 131 | + |
| 132 | +Please be aware that pull requests that seek to introduce a new dependency will be subject to additional review. In general, contributors should avoid dependencies with incompatible licenses, and should try to use recent versions of dependencies. Standard security vulnerability checklists will be consulted before accepting a new dependency. Dependencies on closed-source code, including WebLogic Server, will most likely be rejected. |
0 commit comments