public_git
/
postgres-operator
mirror of https://github.com/zalando/postgres-operator.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

improve docs

This commit is contained in:
Felix Kunde 2020-02-03 13:05:04 +01:00
parent b1fae4d171
commit bc04e92a3d
1 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/administrator.md
View File

@ -493,12 +493,11 @@ Operator [REST API](developer.md#debugging-the-operator). URLs as well as parts
of the UI layout can be configured via environment variables in the of the UI layout can be configured via environment variables in the
[deployment manifest](../ui/manifests/deployment.yaml#L40). [deployment manifest](../ui/manifests/deployment.yaml#L40).
The UI runs with Node.js and comes with it's own Docker image. The UI runs with Node.js and comes with it's own Docker image. Run NPM to
continuously compile `tags/js` code. Basically, it creates an `app.js` file in:
`static/build/app.js`
Run NPM to continuously compile `tags/js` code. Basically, it creates an ```bash
`app.js` file in: `static/build/app.js`
```
(cd ui/app && npm start) (cd ui/app && npm start)
``` ```
@ -511,9 +510,8 @@ make docker
Apply all manifests from the `ui/manifests` folder to deploy the Postgres Apply all manifests from the `ui/manifests` folder to deploy the Postgres
Operator UI on K8s. Replace the image tag in the deployment manifest if you Operator UI on K8s. Replace the image tag in the deployment manifest if you
want to test the image you build with `make docker`. For local tests you also want to test the image you've built with `make docker`. Make sure the pods for
don't need the Ingress resource. Make sure the pods for the operator and the UI the operator and the UI are both running.
are both running.
```bash ```bash
sed -e "s/\(image\:.*\:\).*$/\1$TAG/" manifests/deployment.yaml | kubectl apply -f manifests/ sed -e "s/\(image\:.*\:\).*$/\1$TAG/" manifests/deployment.yaml | kubectl apply -f manifests/
@ -521,18 +519,25 @@ kubectl get all -l application=postgres-operator-ui
``` ```
For local testing you need to apply proxying and port forwarding so that the UI For local testing you need to apply proxying and port forwarding so that the UI
can talk to the K8s and Postgres Operator REST API. You can use the provided can talk to the K8s and Postgres Operator REST API. The Ingress resource is not
`run_local.sh` script for this. Make sure Python dependencies are installed on needed. You can use the provided `run_local.sh` script for this. Make sure
your machine and the correct K8s API server URL is used, e.g. for minikube it Python dependencies are installed on your machine and the correct K8s API server
would usually be `https://192.168.99.100:8443`. When testing in minikube you URL is used, e.g. for minikube it would usually be `https://192.168.99.100:8443`.
have to build the image in its docker environment as `make docker` doesn't do it When testing with minikube you have to build the image in its docker environment
for you. From the `ui` directory execute: (running `make docker` doesn't do it for you). From the `ui` directory execute:
```bash ```bash
# minikube # compile and build operator UI
make docker
# build in image in minikube docker env
eval $(minikube docker-env) eval $(minikube docker-env)
docker build -t registry.opensource.zalan.do/acid/postgres-operator-ui:v1.3.0 . docker build -t registry.opensource.zalan.do/acid/postgres-operator-ui:v1.3.0 .
# apply UI manifests next to a running Postgres Operator
kubectl apply -f manifests/ kubectl apply -f manifests/
# install python dependencies and run UI locally
pip3 install -r requirements
./run_local.sh ./run_local.sh
``` ```