Merge branch 'master' into repo-rename

helm · Jun 30, 2017 · f24155f · f24155f
2 parents 9cb8799 + f473a8f
commit f24155f
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 14 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,6 @@
 # Use older version of Trusty VM due to issues in the updated one
 group: deprecated-2017Q2
+filter_secrets: false
 language: node_js
 node_js:
   - '6.9.5'

diff --git a/README.md b/README.md
@@ -18,16 +18,34 @@ See Monocular in action at [KubeApps.com](https://kubeapps.com) or click [here](
 
 You can use the chart in this repository to install Monocular in your cluster.
 
-##### Prerequisites
+### Prerequisites
 - [Helm and Tiller installed](https://github.com/kubernetes/helm/blob/master/docs/quickstart.md)
-- [Nginx Ingress controller](https://github.com/kubernetes/ingress)
+- [Nginx Ingress controller](https://kubeapps.com/charts/stable/nginx-ingress)
+  - Install with Helm: `helm install stable/nginx-ingress`
+  - **Minikube/Kubeadm**: `helm install stable/nginx-ingress --set controller.hostNetwork=true`
+
 
 ```console
 $ helm repo add monocular https://kubernetes-helm.github.io/monocular
 $ helm install monocular/monocular
 ```
 
-Read more on how to deploy Monocular [here](docs/deployment.md).
+### Access Monocular
+
+Use the Ingress endpoint to access your Monocular instance:
+
+```console
+# Wait for all pods to be running (this can take a few minutes)
+$ kubectl get pods --watch
+
+$ kubectl get ingress
+NAME                        HOSTS     ADDRESS         PORTS     AGE
+tailored-alpaca-monocular   *         192.168.64.30   80        11h
+```
+
+Visit the address specified in the Ingress object in your browser, e.g. http://192.168.64.30.
+
+Read more on how to deploy Monocular [here](deployment/monocular/README.md).
 
 ## Documentation
 

diff --git a/deployment/monocular/Chart.yaml b/deployment/monocular/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v1
 name: monocular
 description: Monocular is a search and discovery front end for Helm Charts Repositories.
-version: 0.4.3
+version: 0.4.4
 appVersion: v0.2.1
 home: https://github.com/kubernetes-helm/monocular
 sources:

diff --git a/deployment/monocular/README.md b/deployment/monocular/README.md
@@ -84,6 +84,20 @@ EOF
 $ helm install monocular/monocular -f custom-repos.yaml
 ```
 
+### Serve Monocular on a single domain
+
+You can configure the Ingress object with the hostnames you wish to serve Monocular on:
+
+```console
+$ cat > custom-domains.yaml <<<EOF
+ingress:
+  hosts:
+  - monocular.local
+EOF
+
+$ helm install monocular/monocular -f custom-domains.yaml
+```
+
 ### Serve Monocular frontend and API on different domains
 
 In order to serve the frontend and the API on different domains, you need to configure the frontend with the API location and configure CORS correctly for the API to accept requests from the frontend.
@@ -110,10 +124,13 @@ Ensure that you replace `$FRONTEND_HOSTNAME` and `$API_HOSTNAME` with the hostna
 
 ### Other configuration options
 
-| Value                                   | Description                                                                                 | Default               |
-|-----------------------------------------|---------------------------------------------------------------------------------------------|-----------------------|
-| `api.livenessProbe.initialDelaySeconds` | Increase this if the API pods are crashing due to the chart repository sync taking too long | `180`                 |
-| `api.config.releasesEnabled`            | Enable installing and managing charts in the cluster                                        | `3600`                |
-| `api.config.cacheRefreshInterval`       | How often to sync with chart repositories                                                   | `3600`                |
-| `ui.googleAnalyticsId`                  | Google Analytics ID                                                                         | `UA-XXXXXX-X` (unset) |
-| `ui.appName`                            | Name to use in title bar and header                                                         | `Monocular`           |
+| Value                                   | Description                                                                                 | Default                                                                         |
+|-----------------------------------------|---------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
+| `api.livenessProbe.initialDelaySeconds` | Increase this if the API pods are crashing due to the chart repository sync taking too long | `180`                                                                           |
+| `api.config.releasesEnabled`            | Enable installing and managing charts in the cluster                                        | `3600`                                                                          |
+| `api.config.cacheRefreshInterval`       | How often to sync with chart repositories                                                   | `3600`                                                                          |
+| `ui.googleAnalyticsId`                  | Google Analytics ID                                                                         | `UA-XXXXXX-X` (unset)                                                           |
+| `ui.appName`                            | Name to use in title bar and header                                                         | `Monocular`                                                                     |
+| `ingress.enabled`                       | If enabled, create an Ingress object                                                        | `true`                                                                          |
+| `ingress.annotations`                   | Ingress annotations                                                                         | `{ingress.kubernetes.io/rewrite-target: /, kubernetes.io/ingress.class: nginx}` |
+| `ingress.tls`                           | TLS configuration for the Ingress object                                                    | `nil`                                                                           |
diff --git a/deployment/monocular/templates/NOTES.txt b/deployment/monocular/templates/NOTES.txt
@@ -1,3 +1,4 @@
+{{- if eq .Values.ui.backendHostname "/api" -}}
 The Monocular chart sets up an Ingress to serve the API and UI on the same
 domain. You can get the address to access Monocular from this Ingress endpoint:
 

diff --git a/deployment/monocular/templates/ingress.yaml b/deployment/monocular/templates/ingress.yaml
@@ -7,8 +7,6 @@ metadata:
   {{- range $key, $value := .Values.ingress.annotations }}
     {{ $key }}: {{ $value | quote }}
   {{- end }}
-    ingress.kubernetes.io/rewrite-target: /
-    kubernetes.io/ingress.class: nginx
   labels:
     app: {{ template "fullname" . }}
     chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"

diff --git a/deployment/monocular/values.yaml b/deployment/monocular/values.yaml
@@ -99,7 +99,9 @@ ingress:
   ## Ingress annotations
   ##
   annotations:
-  #   kubernetes.io/tls-acme: 'true'
+    ingress.kubernetes.io/rewrite-target: /
+    kubernetes.io/ingress.class: nginx
+  #  kubernetes.io/tls-acme: 'true'
 
   ## Ingress TLS configuration
   ## Secrets must be manually created in the namespace