|
| 1 | +# Quick Start Guide |
| 2 | + |
| 3 | +Use this Quick Start Guide to create a WebLogic Kubernetes deployment in a Kubernetes cluster. |
| 4 | +(Maybe add what users would do with this set up.) |
| 5 | + |
| 6 | +(Add link to page that describes a very specific deployment following our [samples flow](http://aseng-wiki.us.oracle.com/asengwiki/display/ASDevWLS/2.0+Samples+Flow) with a Traefik load balancer and just one domain. RM, I'm not sure that this is needed in the Quick Start Guide. **This is a tutorial. What we need are the actual commands for each step listed.**) |
| 7 | + |
| 8 | +## 1. Get the images and put them into your local registry. |
| 9 | +Get all the necessary images: Operator, Traefik. (Need a complete list of the required images and pointers to their locations, including the commands for retrieving the images and where users should locate them on their systems.) |
| 10 | + |
| 11 | +## 2. Create a Traefik (Ingress-based) load balancer. |
| 12 | +Use Helm to install a [Traefik](samples/charts/traefik/README.md) load balancer. (We can't just use a pointer to a script, we need to copy into this guide, the commands for each step.) |
| 13 | + |
| 14 | +## 3. Configure Kibana and Elasticsearch. |
| 15 | +Invoke the script to create these. (Again, list the commands here using an example.) |
| 16 | + |
| 17 | +## 4. Install the operator. |
| 18 | +* Create a namespace and service account for the operator (point to sample script that does this.) |
| 19 | +* Invoke the script to generate the credentials for the operator and add to the Operator YAML, (all the values can be left as default) |
| 20 | +* Create the operator using 'helm install', and passing in the namespace, service account, and location of Elasticsearch (Point to Helm.) |
| 21 | + |
| 22 | +## 5. Prepare your environment for a domain. |
| 23 | +* Create a domain namespace |
| 24 | +* Create the Kubernetes secrets for the Administration Server boot credentials |
| 25 | +* Create a PV & PVC domain; use script |
| 26 | +* Configure the operator to manage the domains in the domain namespace using `helm upgrade` |
| 27 | +* Configure the Traefik load balancer to manage the domains in the domain namespace. |
| 28 | + * Use `helm upgrade` to configure the load balancer to monitor the Ingresses in the domain namespace |
| 29 | +* Create the domain home |
| 30 | +* Create the Docker image for the domain home in the image or use WebLogic binary image. |
| 31 | + * Run WLST to create the domain in PV (remember to apply patch). |
| 32 | + |
| 33 | +## 6. Create a domain. |
| 34 | +* Edit the domain YAML file (can the defaults be used?) |
| 35 | +* Create the domain home for the domain |
| 36 | + * For a domain home on PV – as in sample |
| 37 | + * For a domain home in image, use the sample in the Docker GitHub project |
| 38 | +* Optionally, create a situational configuration template and any additional Kubernetes secrets it needs (for example, to override the domain home configuration of a database URL, username, and password). |
| 39 | +* Create a domain resource in the domain namespace |
| 40 | + * Specify the following information: domain UID, service account, secret name, and domain home details |
| 41 | +* Configure the operator to know about the domain |
| 42 | +* Configure the Traefik load balancer to manage the domain as follows: |
| 43 | + * Create an Ingress for the domain in the domain namespace (it contains the routing rules for the domain) |
| 44 | + |
| 45 | +(At this point, do they have a WebLogic Kubernetes deployment in a Kubernetes cluster? If so, we have to give them something to look at, to verify their results.) |
| 46 | + |
| 47 | +(Removing the domain, operator, and such, isn't really needed in a quick start guide. We can point them to the user's instructions for how to remove the domain, operator, and all the other related resources.) |
| 48 | + |
| 49 | +## 7. Remove a domain. |
| 50 | +* Remove the domain's Kubernetes artifacts (domain resource, secrets, ingress, ...) |
| 51 | + * If they are all tagged with a `weblogicUID` label, then the sample delete domain script will remove them all |
| 52 | + * The operator will notice that the domain's domain resource has been removed and will kill the pods |
| 53 | +* Configure the Traefik Load Balancer to stop managing the domain |
| 54 | + * The delete script will have deleted the Ingress which will tell the load balancer to stop managing the domain |
| 55 | +* Remove the domain home if it's on a pv |
| 56 | + |
| 57 | +## 8. Remove the domain namespace. |
| 58 | +* Configure the Traefik load balancer to stop managing the domain namespace. Use `helm upgrade` to remove the domain namespace from the list of namespaces. |
| 59 | +* Configure the operator to stop managing the domain. Use `helm upgrade` to remove the domain namespace from the list of domain namespaces |
| 60 | +* Remove the PV & PVC for the domain namespace |
| 61 | +* Remove the domain namespace |
| 62 | + |
| 63 | +## 9 Remove the operator. |
| 64 | +* `helm delete --purge` |
| 65 | +* Remove the operator namespace |
| 66 | + |
| 67 | +## 10 Remove other resources. |
| 68 | +* Optionally, remove Kibana and Elasticsearch |
| 69 | +* Remove the Traefik load balancer, using `helm delete --purge` |
| 70 | +* Remove the Traefik namespace |
0 commit comments