Skip to content

Commit 51ad759

Browse files
Merge branch 'develop' into develop-OWLS-70567
2 parents cd81f36 + d1145b5 commit 51ad759

File tree

17 files changed

+265
-304
lines changed

17 files changed

+265
-304
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,32 @@ Oracle is finding ways for organizations using WebLogic Server to run important
2121
The fastest way to experience the operator is to follow the [Quick start guide](site/quickstart.md), or you can peruse our [documentation](site), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](kubernetes/samples/README.md).
2222

2323
```diff
24-
+ The current release of the operator is 2.0-rc1, a release candidate for our 2.0 release.
25-
+ This release candidate was published on Dec 20, 2018.
24+
+ The current release of the operator is 2.0-rc1, a release candidate for our 2.0 release.
25+
+ This release candidate was published on Dec 20, 2018.
2626
+ We expect to publish the final 2.0 release in January 2019.
27-
+ We expect that there will be some minor changes to documentation and samples in the final 2.0 release,
28-
+ however, this release candidate is suitable for testing and early adopters.
27+
+ We expect that there will be some minor changes to documentation and samples in the final 2.0 release.
28+
+ However, this release candidate is suitable for testing and early adopters.
2929
```
3030

31-
# Backward Compatibility Guidelines
31+
## Known issues
32+
33+
| Issue | Description |
34+
| --- | --- |
35+
| [#721](https://github.com/oracle/weblogic-kubernetes-operator/issues/721) | Incorrect default `domainHome` when `domainHomeInImage` is true. |
36+
| [#722](https://github.com/oracle/weblogic-kubernetes-operator/issues/722) | Server services not recreated when labels/annotations changed. |
37+
38+
## Operator version 1.1
39+
40+
Documentation for the 1.1 release of the operator is available [here](site/v1.1/README.md).
41+
42+
# Backward compatibility guidelines
3243

3344
The 2.0 release introduces some breaking changes and does not maintain compatibility with previous releases.
3445

35-
Starting with the 2.0 release, future operator releases are intended to be backwards-compatible with respect to the Domain
36-
resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created
37-
by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We intend to
38-
maintain compatibility for three releases, excepting a clearly communicated deprecated feature, which will be
46+
Starting with the 2.0 release, future operator releases are intended to be backward compatible with respect to the domain
47+
resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created
48+
by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We intend to
49+
maintain compatibility for three releases, except in the case of a clearly communicated deprecated feature, which will be
3950
maintained for one release after a replacement is available.
4051

4152
# About this documentation
@@ -46,7 +57,7 @@ please consult this table of contents:
4657
* The [Quick start guide](site/quickstart.md) explains how to just get the operator running quickly, using all the defaults, nothing special.
4758
* The [User guide](site/user-guide.md) contains detailed information for users of the operator, including how to install and configure it,
4859
and how to use it to create and manage WebLogic domains.
49-
* Our [samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
60+
* Our [Samples](kubernetes/samples/README.md) provide detailed example code and instructions that show you how to perform
5061
various tasks related to the operator.
5162
* The [Developer guide](site/developer.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
5263
API documentation (Javadoc) and Swagger/OpenAPI documentation for the REST APIs.

integration-tests/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<parent>
99
<groupId>oracle.kubernetes</groupId>
1010
<artifactId>operator-parent</artifactId>
11-
<version>2.0-rc1</version>
11+
<version>2.0-SNAPSHOT</version>
1212
</parent>
1313

1414
<artifactId>operator-integration-tests</artifactId>

json-schema-maven-plugin/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<artifactId>operator-parent</artifactId>
77
<groupId>oracle.kubernetes</groupId>
8-
<version>2.0-rc1</version>
8+
<version>2.0-SNAPSHOT</version>
99
</parent>
1010

1111
<artifactId>jsonschema-maven-plugin</artifactId>

json-schema/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<artifactId>operator-parent</artifactId>
77
<groupId>oracle.kubernetes</groupId>
8-
<version>2.0-rc1</version>
8+
<version>2.0-SNAPSHOT</version>
99
</parent>
1010
<modelVersion>4.0.0</modelVersion>
1111

kubernetes/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<parent>
99
<groupId>oracle.kubernetes</groupId>
1010
<artifactId>operator-parent</artifactId>
11-
<version>2.0-rc1</version>
11+
<version>2.0-SNAPSHOT</version>
1212
</parent>
1313

1414
<artifactId>installation-tests</artifactId>

model/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<parent>
99
<groupId>oracle.kubernetes</groupId>
1010
<artifactId>operator-parent</artifactId>
11-
<version>2.0-rc1</version>
11+
<version>2.0-SNAPSHOT</version>
1212
</parent>
1313

1414
<artifactId>operator-model</artifactId>

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/ServerPod.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ class ServerPod {
104104
private List<V1VolumeMount> volumeMounts = new ArrayList<>();
105105

106106
/**
107-
* The labels to be attached to pods.
107+
* The labels to be attached to pods. The label names must not start with 'weblogic.'.
108108
*
109109
* @since 2.0
110110
*/
@@ -120,7 +120,7 @@ class ServerPod {
120120
private Map<String, String> podAnnotations = new HashMap<>();
121121

122122
/**
123-
* The labels to be attached to Service.
123+
* The labels to be attached to Service. The label names must not start with 'weblogic.'.
124124
*
125125
* @since 2.0
126126
*/

operator/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>oracle.kubernetes</groupId>
99
<artifactId>operator-parent</artifactId>
10-
<version>2.0-rc1</version>
10+
<version>2.0-SNAPSHOT</version>
1111
</parent>
1212

1313
<artifactId>weblogic-kubernetes-operator</artifactId>

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<groupId>oracle.kubernetes</groupId>
99
<artifactId>operator-parent</artifactId>
10-
<version>2.0-rc1</version>
10+
<version>2.0-SNAPSHOT</version>
1111

1212
<modules>
1313
<module>model</module>

site/developer.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This guide provides information for developers who wish to understand or contrib
44

55
## Requirements
66

7-
In addition to the requirements listed in [User Guide](user-guide.md#prerequisites), the following software is also required to obtain and build the operator:
7+
In addition to the requirements listed in the [User Guide](user-guide.md#prerequisites), the following software is also required to obtain and build the operator:
88

99
* Git (1.8 or later recommended)
10-
* Java Developer Kit (1.8u131 or later recommended, please use 1.8, tests will not work on 1.9 or later versions)
10+
* Java Developer Kit (1.8u131 or later recommended; please use 1.8, tests will not work on 1.9 or later versions)
1111
* Apache Maven (3.3 or later recommended)
1212

1313
The operator is written primarily in Java, BASH shell scripts, and WLST scripts. The Java code uses features introduced in Java 1.8 -- for example, closures -- but does not use any Java 1.9 feature.
@@ -28,11 +28,11 @@ $ git clone https://github.com/oracle/weblogic-kubernetes-operator.git
2828

2929
The `master` branch is protected and contains source for the latest completed features and bug fixes. While this branch contains active work, we expect to keep it always "ready to release." Therefore, longer running feature work will be performed on specific branches, such as `feature/dynamic-clusters`.
3030

31-
Since we want to balance separating destabilizing work into feature branches against the possibility of later difficult merges, we encourage developers working on features to pull out any necessary refactoring or improvements that are general purpose into their own shorter-lived branches and create pull requests to `master` when these smaller work items are complete.
31+
Because we want to balance separating destabilizing work into feature branches against the possibility of later difficult merges, we encourage developers working on features to pull out any necessary refactoring or improvements that are general purpose into their own shorter-lived branches and create pull requests to `master` when these smaller work items are completed.
3232

3333
All commits to `master` must pass the [integration test suite](#running-integration-tests). Please run these tests locally before submitting a pull request. Additionally, each push to a branch in our GitHub repository triggers a run of a subset of the integration tests with the results visible [here](https://app.wercker.com/Oracle/weblogic-kubernetes-operator/runs).
3434

35-
Please submit pull requests to the `master` branch unless you are collaborating on a feature and have another target branch. Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests on the [README] (README.md).
35+
Please submit pull requests to the `master` branch unless you are collaborating on a feature and have another target branch. Please see details on the Oracle Contributor Agreement (OCA) and guidelines for pull requests on the [README](../README.md).
3636

3737
We will create git tags for each generally available (GA) release of the operator.
3838

@@ -86,7 +86,7 @@ $ docker load < /some/path/operator.tar
8686

8787
Use the Helm charts to [install the operator](helm-charts.md).
8888

89-
If the operator's behavior or Pod log is insufficient to diagnose and resolve failures, then you can connect a Java debugger to the operator using the [debugging options](helm-charts.md#debugging-options).
89+
If the operator's behavior or pod log is insufficient to diagnose and resolve failures, then you can connect a Java debugger to the operator using the [debugging options](helm-charts.md#debugging-options).
9090

9191
## Running integration tests
9292

@@ -103,7 +103,7 @@ $ mvn clean verify -P java-integration-tests
103103

104104
This project has adopted the following coding standards:
105105

106-
* Code will be formated using Oracle / WebLogic standards, which are identical to the [Google Java Style](https://google.github.io/styleguide/javaguide.html)
106+
* Code will be formated using Oracle / WebLogic standards, which are identical to the [Google Java Style](https://google.github.io/styleguide/javaguide.html).
107107
* Javadoc must be provided for all public packages, classes, and methods, and must include all parameters and returns. Javadoc is not required for methods that override or implement methods that are already documented.
108108
* All non-trivial methods should include `LOGGER.entering()` and `LOGGER.exiting()` calls.
109109
* The `LOGGER.exiting()` call should include the value that is going to be returned from the method, unless that value includes a credential or other sensitive information.
@@ -298,4 +298,4 @@ Finally, the operator periodically lists all Domains and rechecks them. This is
298298

299299
## Backward Compatibility Guidelines
300300

301-
Starting with the 2.0 release, future operator releases must be backwards-compatible with respect to the Domain resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We will maintain compatibility for three releases, excepting a clearly communicated deprecated feature, which will be maintained for one release after a replacement is available.
301+
Starting with the 2.0 release, future operator releases must be backward compatible with respect to the domain resource schema, operator Helm chart input values, configuration overrides template, Kubernetes resources created by the operator Helm chart, Kubernetes resources created by the operator, and the operator REST interface. We will maintain compatibility for three releases, except in the case of a clearly communicated deprecated feature, which will be maintained for one release after a replacement is available.

0 commit comments

Comments
 (0)