joshfischer/update k8s docs (#2960)
* change api status url
* further clean up on updated kuberntes versioned urls
* updating missed urls
* further clean up and addig disclaimers
* updating tool template with correct proxy url
* updating notes txt
diff --git a/deploy/kubernetes/general/tools.yaml b/deploy/kubernetes/general/tools.yaml
index 36c903a..d4ab5ce 100644
--- a/deploy/kubernetes/general/tools.yaml
+++ b/deploy/kubernetes/general/tools.yaml
@@ -67,7 +67,7 @@
- >-
heron-ui
--port=8889
- --base_url=/api/v1/proxy/namespaces/default/services/heron-ui:8889
+ --base_url=/api/v1/namespaces/default/services/heron-ui:8889/proxy
---
##
diff --git a/deploy/kubernetes/helm/templates/NOTES.txt b/deploy/kubernetes/helm/templates/NOTES.txt
index c8bb950..fe61182 100644
--- a/deploy/kubernetes/helm/templates/NOTES.txt
+++ b/deploy/kubernetes/helm/templates/NOTES.txt
@@ -4,19 +4,19 @@
kubectl proxy -p 8001
2. Verify you can access the API server
- curl http://localhost:8001/api/v1/proxy/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-apiserver:9000/api/v1/version
+ curl http://localhost:8001/api/v1/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-apiserver:9000/proxy/api/v1/version
3. Verify you can access the heron ui
- open http://localhost:8001/api/v1/proxy/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-ui:8889
+ open http://localhost:8001/api/v1/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-ui:8889/proxy
4. Set your service url
- heron config {{ .Release.Name }} set service_url http://localhost:8001/api/v1/proxy/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-apiserver:9000
+ heron config {{ .Release.Name }} set service_url http://localhost:8001/api/v1/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-apiserver:9000/proxy
5. Submit an example topology
heron submit {{ .Release.Name }} ~/.heron/examples/heron-api-examples.jar org.apache.heron.examples.api.AckingTopology acking
6. Visit the heron ui and see if your example topology is running
- open http://localhost:8001/api/v1/proxy/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-ui:8889
+ open http://localhost:8001/api/v1/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-ui:8889/proxy
7. You can kill the example topology by
heron kill {{ .Release.Name }} acking
diff --git a/deploy/kubernetes/helm/templates/tools.yaml b/deploy/kubernetes/helm/templates/tools.yaml
index 7ee348d..2c7b614 100644
--- a/deploy/kubernetes/helm/templates/tools.yaml
+++ b/deploy/kubernetes/helm/templates/tools.yaml
@@ -108,7 +108,7 @@
- >-
heron-ui
--port=8889
- --base_url=/api/v1/proxy/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-ui:8889
+ --base_url=/api/v1/namespaces/{{ .Release.Namespace }}/services/{{ .Release.Name }}-ui:8889/proxy
- name: heron-apiserver
image: {{ .Values.image }}
imagePullPolicy: {{ .Values.imagePullPolicy }}
diff --git a/deploy/kubernetes/minikube/tools.yaml b/deploy/kubernetes/minikube/tools.yaml
index 6c8e514..535d9b6 100644
--- a/deploy/kubernetes/minikube/tools.yaml
+++ b/deploy/kubernetes/minikube/tools.yaml
@@ -53,7 +53,7 @@
- >-
heron-ui
--port=8889
- --base_url=/api/v1/proxy/namespaces/default/services/heron-ui:8889
+ --base_url=/api/v1/namespaces/default/services/heron-ui:8889/proxy
---
##
diff --git a/website/content/docs/operators/deployment/schedulers/kubernetes-helm.md b/website/content/docs/operators/deployment/schedulers/kubernetes-helm.md
index b38c14f..6bb97f4 100644
--- a/website/content/docs/operators/deployment/schedulers/kubernetes-helm.md
+++ b/website/content/docs/operators/deployment/schedulers/kubernetes-helm.md
@@ -233,23 +233,53 @@
--set platform=baremetal
```
+### Managing topologies
+
+> When setting the `heron` CLI configuration, make sure that the cluster name matches the name of the Helm installation. This can be either the name auto-generated by Helm or the name you supplied via the `--name` flag upon installation (in some of the examples above, the `heron-kubernetes` name was used). Make sure to adjust the name accordingly if necessary.
+
+Once all of the components have been successfully started up, you need to open up a proxy port to your Kubernetes cluster using the [`kubectl proxy`](https://kubernetes.io/docs/tasks/access-kubernetes-api/http-proxy-access-api/) command:
+
+```bash
+$ kubectl proxy -p 8001
+```
+> Note: All of the following Kubernetes specific urls are valid with the Kubernetes 1.10.0 release.
+
+Now, verify that the Heron API server running on Minikube is available using curl:
+
+```bash
+$ curl http://localhost:8001/api/v1/namespaces/default/services/heron-kubernetes-apiserver:9000/proxy/api/v1/version
+```
+
+
+You should get a JSON response like this:
+
+```json
+{
+ "heron.build.git.revision" : "ddbb98bbf173fb082c6fd575caaa35205abe34df",
+ "heron.build.git.status" : "Clean",
+ "heron.build.host" : "ci-server-01",
+ "heron.build.time" : "Sat Mar 31 09:27:19 UTC 2018",
+ "heron.build.timestamp" : "1522488439000",
+ "heron.build.user" : "release-agent",
+ "heron.build.version" : "0.17.8"
+}
+```
+
## Running topologies on Heron on Kubernetes
Once you have a Heron cluster up and running on Kubernetes via Helm, you can use the [`heron` CLI tool](../../../heron-cli) like normal if you set the proper URL for the [Heron API server](../../../heron-api-server). When running Heron on Kubernetes, that URL is:
-```
-http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-kubernetes-heron-apiserver:9000/api/v1/version
+```bash
+$ http://localhost:8001/api/v1/namespaces/default/services/heron-kubernetes-apiserver:9000/proxy
```
To set that URL:
```bash
$ heron config heron-kubernetes set service_url \
- http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-kubernetes-heron-apiserver:9000/api/v1/version
+ http://localhost:8001/api/v1/namespaces/default/services/heron-kubernetes-apiserver:9000/proxy
```
-> When setting the `heron` CLI configuration, make sure that the cluster name matches the name of the Helm installation. This can be either the name auto-generated by Helm or the name you supplied via the `--name` flag upon installation (in some of the examples above, the `heron-kubernetes` name was used). Make sure to adjust the name accordingly if necessary.
-
To test your cluster, you can submit an example topology:
```bash
diff --git a/website/content/docs/operators/deployment/schedulers/kubernetes.md b/website/content/docs/operators/deployment/schedulers/kubernetes.md
index 830baaf..2b3afb7 100644
--- a/website/content/docs/operators/deployment/schedulers/kubernetes.md
+++ b/website/content/docs/operators/deployment/schedulers/kubernetes.md
@@ -104,23 +104,25 @@
$ kubectl proxy -p 8001
```
+> Note: All of the following Kubernetes specific urls are valid with the Kubernetes 1.10.0 release.
+
Now, verify that the Heron API server running on Minikube is available using curl:
```bash
-$ curl http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000/api/v1/version
+$ curl http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy/api/v1/version
```
You should get a JSON response like this:
```json
{
- "heron.build.git.revision" : "bf9fe93f76b895825d8852e010dffd5342e1f860",
+ "heron.build.git.revision" : "ddbb98bbf173fb082c6fd575caaa35205abe34df",
"heron.build.git.status" : "Clean",
"heron.build.host" : "ci-server-01",
- "heron.build.time" : "Sun Oct 1 20:42:18 UTC 2017",
- "heron.build.timestamp" : "1506890538000",
- "heron.build.user" : "release-agent1",
- "heron.build.version" : "0.16.2"
+ "heron.build.time" : "Sat Mar 31 09:27:19 UTC 2018",
+ "heron.build.timestamp" : "1522488439000",
+ "heron.build.user" : "release-agent",
+ "heron.build.version" : "0.17.8"
}
```
@@ -128,7 +130,7 @@
```bash
$ heron submit kubernetes \
- --service-url=http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000 \
+ --service-url=http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy \
~/.heron/examples/heron-api-examples.jar \
org.apache.heron.examples.api.AckingTopology acking
```
@@ -139,7 +141,7 @@
```bash
$ heron config kubernetes set service_url \
- http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000
+ http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy
```
That would enable you to manage topologies without setting the `--service-url` flag.
@@ -148,7 +150,7 @@
The [Heron UI](../../../heron-ui) is an in-browser dashboard that you can use to monitor your Heron [topologies](../../../../concepts/topologies). It should already be running in Minikube.
-You can access [Heron UI](../../../heron-ui) in your browser by navigating to http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-ui:8889.
+You can access [Heron UI](../../../heron-ui) in your browser by navigating to http://localhost:8001/api/v1/namespaces/default/services/heron-ui:8889/proxy/topologies.
## Google Container Engine
@@ -275,11 +277,12 @@
```bash
$ kubectl proxy -p 8001
```
+> Note: All of the following Kubernetes specific urls are valid with the Kubernetes 1.10.0 release.
Now, verify that the Heron API server running on GKE is available using curl:
```bash
-$ curl http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000/api/v1/version
+$ curl http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy/api/v1/version
```
You should get a JSON response like this:
@@ -311,7 +314,7 @@
```bash
$ heron config kubernetes set service_url \
- http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000
+ http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy
```
That would enable you to manage topologies without setting the `--service-url` flag.
@@ -320,7 +323,7 @@
The [Heron UI](../../../heron-ui) is an in-browser dashboard that you can use to monitor your Heron [topologies](../../../../concepts/topologies). It should already be running in your GKE cluster.
-You can access [Heron UI](../../../heron-ui) in your browser by navigating to http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-ui:8889.
+You can access [Heron UI](../../../heron-ui) in your browser by navigating to http://localhost:8001/api/v1/namespaces/default/services/heron-ui:8889/proxy/topologies.
## General Kubernetes clusters
@@ -378,23 +381,25 @@
$ kubectl proxy -p 8001
```
+> Note: All of the following Kubernetes specific urls are valid with the Kubernetes 1.10.0 release.
+
Now, verify that the Heron API server running on GKE is available using curl:
```bash
-$ curl http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000/api/v1/version
+$ curl http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy/api/v1/version
```
You should get a JSON response like this:
```json
{
- "heron.build.git.revision" : "bf9fe93f76b895825d8852e010dffd5342e1f860",
+ "heron.build.git.revision" : "ddbb98bbf173fb082c6fd575caaa35205abe34df",
"heron.build.git.status" : "Clean",
"heron.build.host" : "ci-server-01",
- "heron.build.time" : "Sun Oct 1 20:42:18 UTC 2017",
- "heron.build.timestamp" : "1506890538000",
- "heron.build.user" : "release-agent1",
- "heron.build.version" : "0.16.2"
+ "heron.build.time" : "Sat Mar 31 09:27:19 UTC 2018",
+ "heron.build.timestamp" : "1522488439000",
+ "heron.build.user" : "release-agent",
+ "heron.build.version" : "0.17.8"
}
```
@@ -402,7 +407,7 @@
```bash
$ heron submit kubernetes \
- --service-url=http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000 \
+ --service-url=http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy \
~/.heron/examples/heron-api-examples.jar \
org.apache.heron.examples.api.AckingTopology acking
```
@@ -413,7 +418,7 @@
```bash
$ heron config kubernetes set service_url \
- http://localhost:8001/api/v1/proxy/namespaces/default/services/heron-apiserver:9000
+ http://localhost:8001/api/v1/namespaces/default/services/heron-apiserver:9000/proxy
```
That would enable you to manage topologies without setting the `--service-url` flag.
