Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions site/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ To clone the repository from GitHub, issue this command:
git clone https://github.com/oracle/weblogic-kubernetes-operator
```

## Operator branching model

The ```master``` branch is protected and will always contain source for the latest, generally available (GA)
release of the operator, including any critical hot fixes. No general pull requests will be merged to this branch.

Active work will be performed on the ```develop``` branch. This branch is also protected. Please submit pull
requests to this 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).

Longer running feature work will be performed on specific branches, such as ```feature/dynamic-clusters```. 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 ```develop``` when these smaller work items are complete.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo, are complete, should be are completed.


When it is time for a release, we will branch off ```develop``` to create a per-release branch. Here, we will update version
numbers, rebuild javadoc, if necessary, and perform any other pre-release updates. Finally, this release branch will be merged
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"numbers, rebuild javadocs, if necessary" should it not be "numbers, rebuild javadocs if necessary, and"

to ```master```.

## Building the operator

The operator is built using [Apache Maven](http://maven.apache.org). The build machine will also need to have Docker installed.
Expand Down
41 changes: 40 additions & 1 deletion site/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,46 @@ Note that there is a short video demonstration of the installation process avail
[comment]: # ( Note that you *must* create the `docker-registry` secret in the `weblogic-operator` namespace, so you will need to create the namespace first. )
[comment]: # ( In this command, replace the uppercase items with the appropriate values. The `SECRET_NAME` will be needed in later parameter files. The `NAMESPACE` must match the namespace where the operator will be deployed. )

## Build the Docker image for the operator
## Build the Docker image for the operator using Wercker
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ryan not sure if the "Build the Docker image for the operator using Wercker" should not go immediately after "Build the Docker image for the operator locally" since this section includes requirements for the Operator image.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mriccell But, you don't need to meet any of these requirements to build using Wercker, since the customer will get a box from Wercker's quota and the wrecker.yml ensures that the requirements (java, maven) are satisfied.


You can build, test, and publish the Docker image for the operator directly from Wercker using the ```wercker.yml``` from this repository.

If you haven't done so already, navigate to [wercker.com](https://www.wercker.com) and create an account. Once you are logged in,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once you are logged in, should be After you are logged in.

on the [app.wercker.com] (https://app.wercker.com) page press, "Create your first application."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"press", should be "click"


Select GitHub (the default, if you are new to Wercker). If you haven't done so already, press the "Connect" button within the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"press", should be "click"

larger GitHub button and follow the prompts to provide a login for GitHub. This connects your Wercker and GitHub accounts so
that Wercker pipelines will later be able to clone this repository. Press, "Next."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"press", should be "click" globally.


Select the repository from GitHub. This will be "oracle / weblogic-kubernetes-operator" or a different value if you
forked this repository. Press, "Next."

Configure Wercker's access to the GitHub repository. The default choice, "wercker will check out the code without using an SSH key",
is typically sufficient. Press, "Next."

Verify the settings so far on the review page and press, "Create."

Since this GitHub repository already has a ```wercker.yml``` file, you can skip directly to the "Environment" tab.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Since", should be "Because"


Please provide the following key/value pairs on the environment page. Remember that these values will be
visible to anyone to whom you give access to the Wercker application, therefore, select "Protected" for any
values that should remain hidden, including all passwords.

| Key | Value | OCIR Sample |
| --- | --- | --- |
| DOCKER_USERNAME | Username for the Docker store for pulling serverjre image | |
| DOCKER_PASSWORD | Password for the Docker store | |
| REPO_REGISTRY| Registry address | https://phx.ocir.io/v2 |
| REPO_REPOSITORY | Repository value | phx.ocir.io/<your tenancy>/weblogic-kubernetes-operator |
| REPO_USERNAME | Username for registry | <your tenancy>/<your username> |
| REPO_PASSWORD | Password for registry | Use generated SWIFT password |
| IMAGE_TAG_OPERATOR | Image tag, such as 0.2 or latest | |

Select the "Runs" tab. Skip to the bottom and press, "Trigger your first build now."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Skip" should be "Scroll"


When the run completes successfully, the Docker image for the operator will be built and published to your repository.

## Build the Docker image for the operator locally

The following software are required to obtain and build the operator:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The following software are required" should be "The following software is required"

Expand Down