Skip to content

Commit

Permalink
Prepare docs for 6.0.0-rc.1 (#904)
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha committed Feb 28, 2018
1 parent 94f711a commit 87aeb76
Show file tree
Hide file tree
Showing 101 changed files with 562 additions and 274 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,29 @@ Voyager is a [HAProxy](http://www.haproxy.org/) backed [secure](#certificate) L7
[AppsCode](https://appscode.com). This can be used with any Kubernetes cloud providers including aws, gce, gke, azure, acs. This can also be used with bare metal Kubernetes clusters.

## Ingress
Voyager provides L7 and L4 loadbalancing using a custom Kubernetes [Ingress](https://appscode.com/products/voyager/6.0.0-rc.0/guides/ingress/) resource. This is built on top of the [HAProxy](http://www.haproxy.org/) to support high availability, sticky sessions, name and path-based virtual hosting.
Voyager provides L7 and L4 loadbalancing using a custom Kubernetes [Ingress](https://appscode.com/products/voyager/6.0.0-rc.1/guides/ingress/) resource. This is built on top of the [HAProxy](http://www.haproxy.org/) to support high availability, sticky sessions, name and path-based virtual hosting.
This also support configurable application ports with all the options available in a standard Kubernetes [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).

## Certificate
Voyager can automaticallty provision and refresh SSL certificates issued from Let's Encrypt using a custom Kubernetes [Certificate](https://appscode.com/products/voyager/6.0.0-rc.0/guides/certificate/) resource.
Voyager can automaticallty provision and refresh SSL certificates issued from Let's Encrypt using a custom Kubernetes [Certificate](https://appscode.com/products/voyager/6.0.0-rc.1/guides/certificate/) resource.

## Supported Versions
Please pick a version of Voyager that matches your Kubernetes installation.

| Voyager Version | Docs | Kubernetes Version | Prometheus operator Version |
|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------|--------------------|-----------------------------|
| [6.0.0-rc.0](https://github.com/appscode/voyager/releases/tag/6.0.0-rc.0) (uses CRD) | [User Guide](https://appscode.com/products/voyager/6.0.0-rc.0/) | 1.8.x+ | 0.16.0+ |
| [6.0.0-rc.1](https://github.com/appscode/voyager/releases/tag/6.0.0-rc.1) (uses CRD) | [User Guide](https://appscode.com/products/voyager/6.0.0-rc.1/) | 1.8.x+ | 0.16.0+ |
| [5.0.0-rc.11](https://github.com/appscode/voyager/releases/tag/5.0.0-rc.11) (uses CRD) | [User Guide](https://appscode.com/products/voyager/5.0.0-rc.11/) | 1.7.x | 0.12.0+ |
| [3.2.2](https://github.com/appscode/voyager/releases/tag/3.2.2) (uses TPR) | [User Guide](https://github.com/appscode/voyager/tree/3.2.2/docs) | 1.5.x - 1.7.x | < 0.12.0 |

## Installation
To install Voyager, please follow the guide [here](https://appscode.com/products/voyager/6.0.0-rc.0/setup/install/).
To install Voyager, please follow the guide [here](https://appscode.com/products/voyager/6.0.0-rc.1/setup/install/).

## Using Voyager
Want to learn how to use Voyager? Please start [here](https://appscode.com/products/voyager/6.0.0-rc.0/welcome/).
Want to learn how to use Voyager? Please start [here](https://appscode.com/products/voyager/6.0.0-rc.1/welcome/).

## Contribution guidelines
Want to help improve Voyager? Please start [here](https://appscode.com/products/voyager/6.0.0-rc.0/welcome/contributing/).
Want to help improve Voyager? Please start [here](https://appscode.com/products/voyager/6.0.0-rc.1/welcome/contributing/).

---

Expand Down
2 changes: 1 addition & 1 deletion chart/stable/voyager/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: 'Voyager by AppsCode - Secure Ingress Controller for Kubernetes'
icon: https://cdn.appscode.com/images/icon/voyager.png
name: voyager
version: 3.2.0
appVersion: 6.0.0-rc.0
appVersion: 6.0.0-rc.1
sources:
- https://github.com/appscode/voyager
maintainers:
Expand Down
4 changes: 2 additions & 2 deletions chart/stable/voyager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ The following tables lists the configurable parameters of the Voyager chart and
| Parameter | Description | Default |
| -----------------------------------| ------------------------------------------------------------- | ----------------------|
| `dockerRegistry` | Docker registry used to pull Voyager related images | `appscode` |
| `imageTags.voyager` | Tag of Voyager operator image | `6.0.0-rc.0` |
| `imageTags.haproxy` | Tag of HAProxy container image | `1.7.10-6.0.0-rc.0` |
| `imageTags.voyager` | Tag of Voyager operator image | `6.0.0-rc.1` |
| `imageTags.haproxy` | Tag of HAProxy container image | `1.7.10-6.0.0-rc.1` |
| `imagePullSecrets` | Specify image pull secrets | `nil` (does not add image pull secrets to deployed pods) |
| `imagePullPolicy` | Image pull policy | `IfNotPresent` |
| `cloudProvider` | Name of cloud provider | `nil` |
Expand Down
4 changes: 2 additions & 2 deletions chart/stable/voyager/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ dockerRegistry: appscode
## Tags for Docker images
imageTags:
## Docker image tag containing Voyager
voyager: 6.0.0-rc.0
voyager: 6.0.0-rc.1
## Docker image tag containing HAProxy binary
haproxy: 1.7.10-6.0.0-rc.0
haproxy: 1.7.10-6.0.0-rc.1
## Optionally specify an array of imagePullSecrets.
## Secrets must be manually created in the namespace.
## ref: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
Expand Down
68 changes: 66 additions & 2 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,70 @@
---
title: Docs CHANGELOG
menu:
product_voyager_6.0.0-rc.1:
identifier: changelog-docs
name: Docs CHANGELOG
parent: docs-voyager
weight: 1
product_name: voyager
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: guides
---

# Change Log

## [6.0.0-rc.0](https://github.com/appscode/voyager/tree/6.0.0-rc.0) (2018-02-14)
[Full Changelog](https://github.com/appscode/voyager/compare/5.0.0-rc.11...6.0.0-rc.0)
## [Unreleased](https://github.com/appscode/voyager/tree/HEAD)

[Full Changelog](https://github.com/appscode/voyager/compare/6.0.0-rc.1...HEAD)

**Implemented enhancements:**

- Source IP affinity [\#759](https://github.com/appscode/voyager/issues/759)

**Fixed bugs:**

- basic auth remove on upgrade to 5.0.0-rc11 [\#873](https://github.com/appscode/voyager/issues/873)
- whitelist did not work [\#866](https://github.com/appscode/voyager/issues/866)
- Update voyager docs [\#50](https://github.com/appscode/voyager/issues/50)

**Closed issues:**

- Update Prometheus integration [\#893](https://github.com/appscode/voyager/issues/893)
- Disabling HSTS - doesn't work [\#881](https://github.com/appscode/voyager/issues/881)
- Upgrade from 5.0.0-rc.11 to 6.0.0-rc.1 [\#876](https://github.com/appscode/voyager/issues/876)
- AWS ELB Proxy IP forwarded for occurs errors [\#749](https://github.com/appscode/voyager/issues/749)
- How to use voyager instead of kubernetes nginx ingress controller [\#742](https://github.com/appscode/voyager/issues/742)
- RBAC for voyager [\#732](https://github.com/appscode/voyager/issues/732)
- Document default mode does not work for minikube [\#545](https://github.com/appscode/voyager/issues/545)
- Document how to use Host IP as external IP in minikube for LoadBalancer type Service [\#511](https://github.com/appscode/voyager/issues/511)
- Document RBAC setup on installer page. [\#508](https://github.com/appscode/voyager/issues/508)
- Document external-dns configuration [\#355](https://github.com/appscode/voyager/issues/355)
- Document why each ingress creates a new HAProxy in voyager [\#331](https://github.com/appscode/voyager/issues/331)

**Merged pull requests:**

- Fix service name in chart [\#903](https://github.com/appscode/voyager/pull/903) ([tamalsaha](https://github.com/tamalsaha))
- Update links to latest release [\#901](https://github.com/appscode/voyager/pull/901) ([tamalsaha](https://github.com/tamalsaha))
- Support --enable-admission-webhook=false [\#900](https://github.com/appscode/voyager/pull/900) ([tamalsaha](https://github.com/tamalsaha))
- Support multiple webhooks of same apiversion [\#899](https://github.com/appscode/voyager/pull/899) ([tamalsaha](https://github.com/tamalsaha))
- Sync chart to stable charts repo [\#898](https://github.com/appscode/voyager/pull/898) ([tamalsaha](https://github.com/tamalsaha))
- Document Prometheus integration [\#896](https://github.com/appscode/voyager/pull/896) ([tamalsaha](https://github.com/tamalsaha))
- Improve docs [\#895](https://github.com/appscode/voyager/pull/895) ([tamalsaha](https://github.com/tamalsaha))
- Update haproxy exporter [\#894](https://github.com/appscode/voyager/pull/894) ([tamalsaha](https://github.com/tamalsaha))
- Document user facing RBAC roles [\#892](https://github.com/appscode/voyager/pull/892) ([tamalsaha](https://github.com/tamalsaha))
- Skip generating UpdateStatus method [\#887](https://github.com/appscode/voyager/pull/887) ([tamalsaha](https://github.com/tamalsaha))
- Delete internal types [\#886](https://github.com/appscode/voyager/pull/886) ([tamalsaha](https://github.com/tamalsaha))
- Use official code generator scripts [\#885](https://github.com/appscode/voyager/pull/885) ([tamalsaha](https://github.com/tamalsaha))
- Use HAProxy 1.7.10 [\#884](https://github.com/appscode/voyager/pull/884) ([tamalsaha](https://github.com/tamalsaha))
- Move node selector to Ingress spec [\#883](https://github.com/appscode/voyager/pull/883) ([tamalsaha](https://github.com/tamalsaha))
- Only check NodePort if provided [\#880](https://github.com/appscode/voyager/pull/880) ([tamalsaha](https://github.com/tamalsaha))
- Create user facing aggregate roles [\#879](https://github.com/appscode/voyager/pull/879) ([tamalsaha](https://github.com/tamalsaha))
- Use rbac/v1 api [\#878](https://github.com/appscode/voyager/pull/878) ([tamalsaha](https://github.com/tamalsaha))
- Use github.com/pkg/errors [\#877](https://github.com/appscode/voyager/pull/877) ([tamalsaha](https://github.com/tamalsaha))
- Update docs for supported annotations [\#871](https://github.com/appscode/voyager/pull/871) ([diptadas](https://github.com/diptadas))

## [6.0.0-rc.1](https://github.com/appscode/voyager/tree/6.0.0-rc.1) (2018-02-14)
[Full Changelog](https://github.com/appscode/voyager/compare/5.0.0-rc.11...6.0.0-rc.1)

**Fixed bugs:**

Expand Down Expand Up @@ -43,6 +106,7 @@

**Merged pull requests:**

- Remove bad acl from haproxy template [\#875](https://github.com/appscode/voyager/pull/875) ([tamalsaha](https://github.com/tamalsaha))
- annotations.md typo fix [\#874](https://github.com/appscode/voyager/pull/874) ([mu5h3r](https://github.com/mu5h3r))
- Use service port by default for LB type nodeport [\#870](https://github.com/appscode/voyager/pull/870) ([diptadas](https://github.com/diptadas))
- Fixed configmap cleanup when ingress deleted [\#869](https://github.com/appscode/voyager/pull/869) ([diptadas](https://github.com/diptadas))
Expand Down
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Contributing | Voyager
description: Contributing
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: contributing-voyager
name: Contributing
parent: welcome
weight: 10
product_name: voyager
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: welcome
url: /products/voyager/6.0.0-rc.0/welcome/contributing/
url: /products/voyager/6.0.0-rc.1/welcome/contributing/
aliases:
- /products/voyager/6.0.0-rc.0/CONTRIBUTING/
- /products/voyager/6.0.0-rc.1/CONTRIBUTING/
---

# Contribution Guidelines
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
title: Weclome | Voyager
description: Welcome to Voyager
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: readme-voyager
name: Readme
parent: welcome
weight: -1
product_name: voyager
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: welcome
url: /products/voyager/6.0.0-rc.0/welcome/
url: /products/voyager/6.0.0-rc.1/welcome/
aliases:
- /products/voyager/6.0.0-rc.0/
- /products/voyager/6.0.0-rc.0/README/
- /products/voyager/6.0.0-rc.1/
- /products/voyager/6.0.0-rc.1/README/
---

# Voyager
Expand Down
4 changes: 2 additions & 2 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Docs | Voyager
description: Voyager Docs
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: welcome
name: Welcome
weight: 10
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
---
8 changes: 4 additions & 4 deletions docs/acknowledgement.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Acknowledgement | Voyager
description: Acknowledgement
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: acknowledgement-voyager
name: Acknowledgement
parent: welcome
weight: 20
product_name: voyager
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: welcome
url: /products/voyager/6.0.0-rc.0/welcome/acknowledgement/
url: /products/voyager/6.0.0-rc.1/welcome/acknowledgement/
aliases:
- /products/voyager/6.0.0-rc.0/acknowledgement/
- /products/voyager/6.0.0-rc.1/acknowledgement/
---

# Acknowledgement
Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Concepts | Voyager
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: concepts-readme
name: Readme
parent: concepts
weight: -1
product_name: voyager
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: concepts
url: /products/voyager/6.0.0-rc.0/concepts/
url: /products/voyager/6.0.0-rc.1/concepts/
aliases:
- /products/voyager/6.0.0-rc.0/concepts/README/
- /products/voyager/6.0.0-rc.1/concepts/README/
---
# Concepts

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Guides
description: Voyager Guides
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: concepts
name: Concepts
weight: 20
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
---
4 changes: 2 additions & 2 deletions docs/concepts/ingress-types/_index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Types of Ingress | Voyager
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: ingress-types-concepts
name: Types of Ingress
parent: concepts
weight: 15
product_name: voyager
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: concepts
---
10 changes: 5 additions & 5 deletions docs/concepts/ingress-types/hostport.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: HostPort Ingress | Voyager
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: hostport-ingress
name: HostPort
parent: ingress-types-concepts
weight: 20
product_name: voyager
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: concepts
---

Expand All @@ -20,22 +20,22 @@ In `HostPort` type Ingress, HAProxy pods are run via a Kubernetes deployment nam
- First, deploy voyager operator.

```console
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.0/hack/deploy/voyager.sh \
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.1/hack/deploy/voyager.sh \
| bash -s -- --provider=minikube
```

- Now, deploy test servers using [this script](/docs/examples/ingress/types/hostport/deploy-servers.sh) script.

```console
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.0/docs/examples/ingress/types/hostport/deploy-servers.sh | bash
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.1/docs/examples/ingress/types/hostport/deploy-servers.sh | bash

deployment "nginx" created
service "web" exposed
deployment "echoserver" created
service "rest" exposed
```

- Now, create an Ingress object running `kubectl apply -f https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.0/docs/examples/ingress/types/hostport/ing.yaml`. Please note the annotaiton on ingress:
- Now, create an Ingress object running `kubectl apply -f https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.1/docs/examples/ingress/types/hostport/ing.yaml`. Please note the annotaiton on ingress:

```yaml
annotations:
Expand Down
10 changes: 5 additions & 5 deletions docs/concepts/ingress-types/internal.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Internal Ingress | Voyager
menu:
product_voyager_6.0.0-rc.0:
product_voyager_6.0.0-rc.1:
identifier: internal-ingress
name: Internal
parent: ingress-types-concepts
weight: 25
product_name: voyager
menu_name: product_voyager_6.0.0-rc.0
menu_name: product_voyager_6.0.0-rc.1
section_menu_id: concepts
---

Expand All @@ -20,22 +20,22 @@ In `Internal` type Ingress, HAProxy pods are exposed via a ClusterIP type Kubern
- First, deploy voyager operator.

```console
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.0/hack/deploy/voyager.sh \
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.1/hack/deploy/voyager.sh \
| bash -s -- --provider=minikube
```

- Now, deploy test servers using [this script](/docs/examples/ingress/types/internal/deploy-servers.sh) script.

```console
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.0/docs/examples/ingress/types/internal/deploy-servers.sh | bash
curl -fsSL https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.1/docs/examples/ingress/types/internal/deploy-servers.sh | bash

deployment "nginx" created
service "web" exposed
deployment "echoserver" created
service "rest" exposed
```

- Now, create an Ingress object running `kubectl apply -f https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.0/docs/examples/ingress/types/internal/ing.yaml`. Please note the annotaiton on ingress:
- Now, create an Ingress object running `kubectl apply -f https://raw.githubusercontent.com/appscode/voyager/6.0.0-rc.1/docs/examples/ingress/types/internal/ing.yaml`. Please note the annotaiton on ingress:

```yaml
annotations:
Expand Down
Loading

0 comments on commit 87aeb76

Please sign in to comment.