Skip to content

Commit 0efd5a0

Browse files
fix links to samples, jenkins-ignore
1 parent 3452d28 commit 0efd5a0

17 files changed

+64
-64
lines changed

site/v1.0/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Oracle WebLogic Server Kubernetes Operator Documentation
22

3-
**WARNING** This directory contains the documentation for version 1.0 of the operator, which is an old release.
3+
**WARNING** This directory contains the documentation for version 1.0 of the operator, which is an old release.
44

55
If you wish to view documentation for the current version [please click here](..).
66

@@ -159,13 +159,13 @@ You can choose a load balancer provider for your WebLogic domains running in a K
159159

160160
## Shutting down a domain
161161

162-
For information about how to shut down a domain running in Kubernetes, see [Shutting down a domain](site/shutdown-domain.md) .
162+
For information about how to shut down a domain running in Kubernetes, see [Shutting down a domain](shutdown-domain.md) .
163163

164164
## Removing a domain
165165

166-
To permanently remove the Kubernetes resources for a domain from a Kubernetes cluster, run the [Delete WebLogic domain resources](/kubernetes/delete-weblogic-domain-resources.sh) script. This script will delete a specific domain, or all domains, and all the Kubernetes resources associated with a set of given domains. The script will also attempt a clean shutdown of a domain’s WebLogic pods before deleting its resources.  You can run the script in a test mode to show what would be shutdown and deleted without actually performing the shutdowns and deletions.   For script help, use its `-h` option.
166+
To permanently remove the Kubernetes resources for a domain from a Kubernetes cluster, run the [Delete WebLogic domain resources](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/delete-domain) script. This script will delete a specific domain, or all domains, and all the Kubernetes resources associated with a set of given domains. The script will also attempt a clean shutdown of a domain’s WebLogic pods before deleting its resources.  You can run the script in a test mode to show what would be shutdown and deleted without actually performing the shutdowns and deletions.   For script help, use its `-h` option.
167167

168-
The script will remove only domain-related resources which are labeled with the `domainUID` label, such as resources created by the [Create WebLogic domain](/kubernetes/create-weblogic-domain.sh) script or the [integration tests](/src/integration-tests/bash/run.sh).  If you manually created resources and have not labelled them with a `domainUID`, the script will not remove them.   One way to label a resource that has already been deployed is:
168+
The script will remove only domain-related resources which are labeled with the `domainUID` label, such as resources created by the [Create WebLogic domain](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/create-weblogic-domain/) script or the [integration tests](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/src/integration-tests/bash).  If you manually created resources and have not labelled them with a `domainUID`, the script will not remove them.   One way to label a resource that has already been deployed is:
169169

170170
```
171171
kubectl -n <Namespace> label <ResourceType> <ResourceName> domainUID=<domainUID>

site/v1.1/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Oracle WebLogic Server Kubernetes Operator Documentation
22

3-
**WARNING** This directory contains the documentation for version 1.1 of the operator, which is an old release.
3+
**WARNING** This directory contains the documentation for version 1.1 of the operator, which is an old release.
44

55
If you wish to view documentation for the current version [please click here](..).
66

@@ -153,9 +153,9 @@ For more information, see [Scaling a WebLogic cluster](scaling.md).
153153
## Load balancing with an Ingress controller or a web server
154154

155155
You can choose a load balancer provider for your WebLogic domains running in a Kubernetes cluster. Please refer to the following sections for information about the current capabilities and setup instructions for each of the supported load balancers.
156-
* [Load balancing with Voyager/HAProxy](voyager.md)
156+
* [Load balancing with Voyager/HAProxy](voyager.md)
157157
* [Load balancing with Traefik](traefik.md)
158-
* [Load balancing with the Apache HTTP Server](apache.md)
158+
* [Load balancing with the Apache HTTP Server](apache.md)
159159

160160
[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.)
161161

@@ -165,15 +165,15 @@ For information about how to shut down a domain running in Kubernetes, see [Shut
165165

166166
## Removing a domain
167167

168-
To permanently remove the Kubernetes resources for a domain from a Kubernetes cluster, run the [Delete WebLogic domain resources](/kubernetes/delete-weblogic-domain-resources.sh) script. This script will delete a specific domain, or all domains, and all the Kubernetes resources associated with a set of given domains. The script will also attempt a clean shutdown of a domain’s WebLogic pods before deleting its resources.  You can run the script in a test mode to show what would be shutdown and deleted without actually performing the shutdowns and deletions.   For script help, use its `-h` option.
168+
To permanently remove the Kubernetes resources for a domain from a Kubernetes cluster, run the [Delete WebLogic domain resources](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/delete-domain) script. This script will delete a specific domain, or all domains, and all the Kubernetes resources associated with a set of given domains. The script will also attempt a clean shutdown of a domain’s WebLogic pods before deleting its resources.  You can run the script in a test mode to show what would be shutdown and deleted without actually performing the shutdowns and deletions.   For script help, use its `-h` option.
169169

170-
The script will remove only domain-related resources which are labeled with the `domainUID` label, such as resources created by the [Create WebLogic domain](/kubernetes/create-weblogic-domain.sh) script or the [integration tests](/src/integration-tests/bash/run.sh).  If you manually created resources and have not labelled them with a `domainUID`, the script will not remove them.   One way to label a resource that has already been deployed is:
170+
The script will remove only domain-related resources which are labeled with the `domainUID` label, such as resources created by the [Create WebLogic domain](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/create-weblogic-domain/) script or the [integration tests](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/src/integration-tests/bash).  If you manually created resources and have not labelled them with a `domainUID`, the script will not remove them.   One way to label a resource that has already been deployed is:
171171

172172
```
173173
kubectl -n <Namespace> label <ResourceType> <ResourceName> domainUID=<domainUID>
174174
```
175175

176-
By default, the domain's persistent volume claim and the persistent volume are created by the [Create WebLogic domain](/kubernetes/create-weblogic-domain.sh) script, and are removed by the [Delete WebLogic domain resources](/kubernetes/delete-weblogic-domain-resources.sh) script. To manually remove the persistent volume claim and the persistent volume, use these commands:
176+
By default, the domain's persistent volume claim and the persistent volume are created by the [Create WebLogic domain](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/create-weblogic-domain/) script, and are removed by the [Delete WebLogic domain resources](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/delete-domain) script. To manually remove the persistent volume claim and the persistent volume, use these commands:
177177

178178
```
179179
kubectl delete pvc PVC-NAME -n NAMESPACE
@@ -194,7 +194,7 @@ This can be achieved by following the steps below. For convenience of discussion
194194
-o /path/to/weblogic-operator-output-directory
195195
```
196196

197-
* Delete the domain using the [Delete WebLogic domain resources](/kubernetes/delete-weblogic-domain-resources.sh) script.
197+
* Delete the domain using the [Delete WebLogic domain resources](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/delete-domain) script.
198198

199199
```
200200
./delete-weblogic-domain-resources.sh -d <domainUID>
@@ -203,8 +203,8 @@ This can be achieved by following the steps below. For convenience of discussion
203203
* Delete the contents of the physical volume using the appropriate tools. See the descriptions in the previous section for removing a domain.
204204
* Delete the contents in the `weblogic-domains/<domainUID>` directory under the output directory that is specified when the domain is originally created, which is `/path/to/weblogic-operator-output-directory` in our example.
205205
* Update the create WebLogic domain inputs file `create-domain-job-inputs.yaml`.
206-
* Recreate all resources that are labeled with the `domainUID`, but are not created by the [Create WebLogic domain](kubernetes/create-weblogic-domain.sh) script. One example of such resources is the `secret` for the domain credentials, which often is created manually and may be labeled with `domainUID`. Any resources that are not labeled with the `domainUID` are not affected because they are not deleted by the [Delete WebLogic domain resources](kubernetes/delete-weblogic-domain-resources.sh) script.
207-
* Recreate the domain using the [Create WebLogic domain](kubectles/create-weblogic-domain.sh) script with the updated create WebLogic domain inputs file.
206+
* Recreate all resources that are labeled with the `domainUID`, but are not created by the [Create WebLogic domain](kubernetes/create-weblogic-domain.sh) script. One example of such resources is the `secret` for the domain credentials, which often is created manually and may be labeled with `domainUID`. Any resources that are not labeled with the `domainUID` are not affected because they are not deleted by the [Delete WebLogic domain resources](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/delete-domain) script.
207+
* Recreate the domain using the [Create WebLogic domain](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/create-weblogic-domain/) script with the updated create WebLogic domain inputs file.
208208
209209
If for some reason the last step fails, then repeat the steps above after deleting the failed create WebLogic domain job, using the following command. The `<output-dir>` is the directory that is specified to the create WebLogic domain script via the `-o` option, which is `/path/to/weblogic-operator-output-directory` in our example if the same command is used to recreate the domain.
210210
@@ -228,7 +228,7 @@ To remove more than one operator, repeat these steps for each operator namespace
228228
229229
# Developer guide
230230
231-
Developers interested in this project are encouraged to read the [Developer guide](site/developer.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 Kuberentes API.
231+
Developers interested in this project are encouraged to read the [Developer guide](developer.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 Kuberentes API.
232232
233233
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 you would like to contribute to!
234234

site/v2.0.1/domain-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The following prerequisites must be fulfilled before proceeding with the creatio
1515

1616
Domain resources are defined using the domain resource YAML files. For each WLS domain you want to create and configure, you should create one domain resource YAML file and apply it. In the example referenced below, the sample script, `create-domain.sh`, generates a domain resource YAML file that you can use as a basis. Copy the file and override the default settings so that it matches all the WLS domain parameters that define your WLS domain.
1717

18-
See the [WebLogic sample domain home on a persistent volume README](../kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/README.md).
18+
See the [WebLogic sample domain home on a persistent volume README](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/README.md).
1919

2020
# Kubernetes resources
2121

site/v2.0.1/domains.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
3131
numbers, and hyphens.
3232

3333
1. Create a Kubernetes secret containing the Administration Server boot credentials. You can do this manually or by using
34-
[the provided sample](/kubernetes/samples/scripts/create-weblogic-domain-credentials/README.md). To create
34+
[the provided sample](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain-credentials/README.md). To create
3535
the secret manually, use this command:
3636

3737
```
@@ -47,10 +47,10 @@ Perform these steps to prepare your Kubernetes cluster to run a WebLogic domain:
4747
Replace the string `weblogic` in the third line with the user name for the administrative user.
4848
Replace the string `welcome1` in the fourth line with the password.
4949

50-
1. Optionally, [create a PV & persistent volume claim (PVC)](/kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/README.md) which can hold the domain home, logs, and application binaries.
50+
1. Optionally, [create a PV & persistent volume claim (PVC)](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain-pv-pvc/README.md) which can hold the domain home, logs, and application binaries.
5151
Even if you put your domain in a Docker image, you may want to put the logs on a persistent volume so that they are available after the pods terminate.
5252
This may be instead of, or as well as, other approaches like streaming logs into Elasticsearch.
53-
1. [Configure load balancer(s)](/kubernetes/samples/charts/README.md) to manage access to any WebLogic clusters.
53+
1. [Configure load balancer(s)](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/README.md) to manage access to any WebLogic clusters.
5454

5555
### Important considerations for WebLogic domains in Kubernetes
5656

@@ -102,12 +102,12 @@ Please consult My Oracle Support Doc ID 2349228.1 for up-to-date information abo
102102
### Creating and managing WebLogic domains
103103

104104
In this version of the operator, a WebLogic domain can be located either in a persistent volume (PV) or in a Docker image.
105-
For examples of each, see the [WebLogic operator samples](../kubernetes/samples/README.md).
105+
For examples of each, see the [WebLogic operator samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/README.md).
106106

107107
If you want to create your own Docker images, for example, to choose a specific set of patches or to create a domain
108108
with a specific configuration and/or applications deployed, then you can create the domain custom resource
109109
manually to deploy your domain. This process is documented in [this
110-
sample](../kubernetes/samples/scripts/create-weblogic-domain/manually-create-domain/README.md).
110+
sample](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/scripts/create-weblogic-domain/manually-create-domain/README.md).
111111

112112
### Modifying domain configurations
113113

site/v2.0.1/ingress.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For example, if the `domainUID` is `domain1` and the cluster name is `cluster-1`
1818
will be named `domain1-cluster-cluster-1`.
1919

2020
The service name must comply with standard Kubernetes rules for naming of objects and in particular with DNS-1035:
21-
> A DNS-1035 label must consist of lower case alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character (e.g. 'my-name', or 'abc-123', regex used for validation is '[a-z]([-a-z0-9]*[a-z0-9])?').
21+
> A DNS-1035 label must consist of lower case alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character (e.g. 'my-name', or 'abc-123', regex used for validation is `[a-z]([-a-z0-9]*[a-z0-9])?`).
2222
2323
To comply with these requirements, if the `domainUID` or the cluster name contains some upper-case characters or underscores, then
2424
in the service name the upper-case characters will be converted to lower-case and underscores will be converted to hyphens.
@@ -32,7 +32,7 @@ object and the load balancer will route traffic to the WebLogic servers within t
3232
understand that there are zero or more actual pods behind the service, and they actually
3333
build their backend list and route requests to those backends directly, not through the service. This means that
3434
requests are properly balanced across the pods, according to the load balancing algorithm
35-
in use. Most Ingress controllers also
35+
in use. Most Ingress controllers also
3636
subscribe to updates on the service and adjust their internal backend sets when
3737
additional pods become ready, or pods enter a non-ready state.
3838

@@ -47,7 +47,7 @@ additional pods become ready, or pods enter a non-ready state.
4747
Ingress resources contain routing rules to one or more backends. An Ingress controller is responsible to apply the rules to the underlying load balancer.
4848
There are two approaches to create the Ingress resource:
4949

50-
a. Use the Helm chart [ingress-per-domain](../kubernetes/samples/charts/ingress-per-domain).
50+
a. Use the Helm chart [ingress-per-domain](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/ingress-per-domain).
5151

5252
Each Ingress provider supports a number of annotations in Ingress resources. This Helm chart allows you to define the routing rules without dealing with the detailed provider-specific annotations. Currently we support two Ingress providers: Traefik and Voyager.
5353

@@ -58,9 +58,9 @@ additional pods become ready, or pods enter a non-ready state.
5858
## Guide and samples for Traefik and Voyager/HAProxy
5959
Traefik and Voyager/HAProxy are both popular Ingress controllers.
6060
Information about how to install and configure these to load balance WebLogic clusters is provided here:
61-
- [Traefik guide](../kubernetes/samples/charts/traefik/README.md)
62-
- [Voyager guide](../kubernetes/samples/charts/voyager/README.md)
61+
- [Traefik guide](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/traefik/README.md)
62+
- [Voyager guide](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/voyager/README.md)
6363

6464
Samples are also provided for these two Ingress controllers, showing how to manage multiple WebLogic clusters as the backends, using different routing rules, host-routing and path-routing; and TLS termination:
65-
- [Traefik samples](../kubernetes/samples/charts/traefik/samples)
66-
- [Voyager samples](../kubernetes/samples/charts/voyager/samples)
65+
- [Traefik samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/traefik/samples)
66+
- [Voyager samples](https://github.com/oracle/weblogic-kubernetes-operator/blob/master/kubernetes/samples/charts/voyager/samples)

0 commit comments

Comments
 (0)