Skip to content

Commit

Permalink
Prepare docs for 5.0.0-rc.11
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha committed Jan 4, 2018
1 parent cd114c1 commit e337755
Show file tree
Hide file tree
Showing 85 changed files with 539 additions and 582 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -18,7 +18,7 @@ Please pick a version of Voyager that matches your Kubernetes installation.

| Voyager Version | Docs | Kubernetes Version | Prometheus operator Version |
|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------|--------------------|-----------------------------|
| [5.0.0-rc.10](https://github.com/appscode/voyager/releases/tag/5.0.0-rc.10) (uses CRD) | [User Guide](https://github.com/appscode/voyager/tree/5.0.0-rc.10/docs) | 1.7.x+ | 0.12.0+ |
| [5.0.0-rc.11](https://github.com/appscode/voyager/releases/tag/5.0.0-rc.11) (uses CRD) | [User Guide](https://github.com/appscode/voyager/tree/5.0.0-rc.11/docs) | 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
Expand Down
2 changes: 1 addition & 1 deletion chart/stable/voyager/Chart.yaml
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: 2.0.0
appVersion: 5.0.0-rc.10
appVersion: 5.0.0-rc.11
sources:
- https://github.com/appscode/voyager
maintainers:
Expand Down
6 changes: 3 additions & 3 deletions chart/stable/voyager/README.md
Expand Up @@ -43,11 +43,11 @@ The following tables lists the configurable parameters of the Voyager chart and
| Parameter | Description | Default |
| --------------------------| ------------------------------------------------------------- | ------------------ |
| `operator.image` | Name of Voyager operator image | `appscode/voyager` |
| `operator.imageTag` | Tag of Voyager operator image | `5.0.0-rc.10` |
| `operator.imageTag` | Tag of Voyager operator image | `5.0.0-rc.11` |
| `haproxy.image` | Name of HAProxy container image | `appscode/haproxy` |
| `haproxy.imageTag` | Tag of HAProxy container image | `1.7.9-5.0.0-rc.10` |
| `haproxy.imageTag` | Tag of HAProxy container image | `1.7.9-5.0.0-rc.11` |
| `exporter.image` | Name of Prometheus exporter sidecar image | `appscode/voyager` |
| `exporter.imageTag` | Tag of Prometheus exporter sidecar image | `5.0.0-rc.10` |
| `exporter.imageTag` | Tag of Prometheus exporter sidecar image | `5.0.0-rc.11` |
| `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
6 changes: 3 additions & 3 deletions chart/stable/voyager/values.yaml
Expand Up @@ -3,15 +3,15 @@
##
operator:
image: appscode/voyager
imageTag: 5.0.0-rc.10
imageTag: 5.0.0-rc.11
## Docker image containing HAProxy binary
haproxy:
image: appscode/haproxy
imageTag: 1.7.9-5.0.0-rc.10
imageTag: 1.7.9-5.0.0-rc.11
## Docker image containing Prometheus exporter
exporter:
image: appscode/voyager
imageTag: 5.0.0-rc.10
imageTag: 5.0.0-rc.11
## 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
28 changes: 16 additions & 12 deletions docs/CONTRIBUTING.md
Expand Up @@ -2,20 +2,23 @@
title: Contributing | Voyager
description: Contributing
menu:
product_voyager_5.0.0-rc.10:
product_voyager_5.0.0-rc.11:
identifier: contributing-voyager
name: Contributing
parent: getting-started
weight: 35
parent: welcome
weight: 10
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
section_menu_id: getting-started
url: /products/voyager/5.0.0-rc.10/getting-started/contributing/
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: welcome
url: /products/voyager/5.0.0-rc.11/welcome/contributing/
aliases:
- /products/voyager/5.0.0-rc.11/CONTRIBUTING/
---

# Contribution Guidelines
Want to hack on Voyager?

AppsCode projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
AppsCode projects are [Apache 2.0 licensed](https://github.com/appscode/voyager/blob/master/LICENSE) and accept contributions via
GitHub pull requests. This document outlines some of the conventions on
development workflow, commit message formatting, contact points and other
resources to make it easier to get your contribution accepted.
Expand All @@ -25,25 +28,26 @@ resources to make it easier to get your contribution accepted.
By contributing to this project you agree to the Developer Certificate of
Origin (DCO). This document was created by the Linux Kernel community and is a
simple statement that you, as a contributor, have the legal right to make the
contribution. See the [DCO](DCO) file for details.
contribution. See the [DCO](https://github.com/appscode/voyager/blob/master/DCO) file for details.

## Developer Guide

We have a [Developer Guide](/docs/setup/developer-guide/README.md) that outlines everything you need to know from setting up your
We have a [Developer Guide](/docs/setup/developer-guide/overview.md) that outlines everything you need to know from setting up your
dev environment to how to build and test Voyager. If you find something undocumented or incorrect along the way,
please feel free to send a Pull Request.

## Getting Help

If you have a question about Voyager or having problem using it, you can contact us on our public Slack channel. Follow [this link](https://slack.appscode.com) to get invitation to our Slack channel.
If you have a question about Voyager or having problem using it, you can contact us on the [AppsCode Slack team](https://appscode.slack.com/messages/C0XQFLGRM/details/) channel `#general`. Follow [this link](https://slack.appscode.com) to get invitation to our Slack channel.

## Bugs/Feature request

If you have found a bug with Voyager or want to request for new features, please [file an issue](https://github.com/appscode/Voyager/issues/new).
If you have found a bug with Voyager or want to request for new features, please [file an issue](https://github.com/appscode/voyager/issues/new).

## Submit PR

If you fix a bug or developed a new feature, feel free to submit a PR. In either case, please file a [Github issue]((https://github.com/appscode/Voyager/issues/new)) first, so that we can have a discussion on it. This is a rough outline of what a contributor's workflow looks like:
If you fix a bug or developed a new feature, feel free to submit a PR. In either case, please file a [Github issue](https://github.com/appscode/voyager/issues/new) first, so that we can have a discussion on it. This is a rough outline of what a contributor's workflow looks like:


- Create a topic branch from where you want to base your work (usually master).
- Make commits of logical units.
Expand Down
25 changes: 13 additions & 12 deletions docs/README.md
@@ -1,22 +1,23 @@
---
title: Overview | Voyager
description: Overview of Voyager
title: Weclome | Voyager
description: Welcome to Voyager
menu:
product_voyager_5.0.0-rc.10:
identifier: overview-voyager
name: Overview
parent: getting-started
weight: 20
product_voyager_5.0.0-rc.11:
identifier: readme-voyager
name: Readme
parent: welcome
weight: -1
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
section_menu_id: getting-started
url: /products/voyager/5.0.0-rc.10/getting-started/
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: welcome
url: /products/voyager/5.0.0-rc.11/welcome/
aliases:
- /products/voyager/5.0.0-rc.10/
- /products/voyager/5.0.0-rc.10/README/
- /products/voyager/5.0.0-rc.11/
- /products/voyager/5.0.0-rc.11/README/
---

# Voyager

Voyager is a [HAProxy](http://www.haproxy.org/) backed secure L7 and L4 ingress controller for Kubernetes developed by [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.

From here you can learn all about Voyager's architecture and how to deploy and use Voyager.
Expand Down
8 changes: 4 additions & 4 deletions docs/_index.md
Expand Up @@ -2,9 +2,9 @@
title: Docs | Voyager
description: Voyager Docs
menu:
product_voyager_5.0.0-rc.10:
identifier: getting-started
name: Getting Started
product_voyager_5.0.0-rc.11:
identifier: welcome
name: Welcome
weight: 10
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
---
14 changes: 8 additions & 6 deletions docs/acknowledgement.md
Expand Up @@ -2,15 +2,17 @@
title: Acknowledgement | Voyager
description: Acknowledgement
menu:
product_voyager_5.0.0-rc.10:
product_voyager_5.0.0-rc.11:
identifier: acknowledgement-voyager
name: Acknowledgement
parent: getting-started
weight: 40
parent: welcome
weight: 20
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
section_menu_id: getting-started
url: /products/voyager/5.0.0-rc.10/getting-started/acknowledgement/
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: welcome
url: /products/voyager/5.0.0-rc.11/welcome/acknowledgement/
aliases:
- /products/voyager/5.0.0-rc.11/acknowledgement/
---

# Acknowledgement
Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/README.md
@@ -1,17 +1,17 @@
---
title: Concepts | Voyager
menu:
product_voyager_5.0.0-rc.10:
product_voyager_5.0.0-rc.11:
identifier: concepts-readme
name: Readme
parent: concepts
weight: -1
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: concepts
url: /products/voyager/5.0.0-rc.10/concepts/
url: /products/voyager/5.0.0-rc.11/concepts/
aliases:
- /products/voyager/5.0.0-rc.10/concepts/README/
- /products/voyager/5.0.0-rc.11/concepts/README/
---

# Concepts
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/_index.md
Expand Up @@ -2,9 +2,9 @@
title: Guides
description: Voyager Guides
menu:
product_voyager_5.0.0-rc.10:
product_voyager_5.0.0-rc.11:
identifier: concepts
name: Concepts
weight: 20
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
---
4 changes: 2 additions & 2 deletions docs/concepts/ingress-class.md
Expand Up @@ -2,13 +2,13 @@
title: Ingress Class | Voyager
description: Ingress Class
menu:
product_voyager_5.0.0-rc.10:
product_voyager_5.0.0-rc.11:
identifier: ingress-class
name: Ingress Class
parent: concepts
weight: 40
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: concepts
---

Expand Down
15 changes: 7 additions & 8 deletions docs/concepts/overview.md
Expand Up @@ -2,30 +2,29 @@
title: Overview | Voyager
description: Overview of Voyager
menu:
product_voyager_5.0.0-rc.10:
product_voyager_5.0.0-rc.11:
identifier: overview-voyager
name: Overview
parent: getting-started
parent: concepts
weight: 20
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: getting-started
url: /products/voyager/5.0.0-rc.10/getting-started/
url: /products/voyager/5.0.0-rc.11/getting-started/
aliases:
- /products/voyager/5.0.0-rc.10/
- /products/voyager/5.0.0-rc.10/README/
- /products/voyager/5.0.0-rc.11/
- /products/voyager/5.0.0-rc.11/README/
---

# Voyager
Voyager is a [HAProxy](http://www.haproxy.org/) backed [secure](#certificate) L7 and L4 [ingress](#ingress) controller for Kubernetes developed by
[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
# Ingress
Voyager provides L7 and L4 loadbalancing using a custom Kubernetes [Ingress](/docs/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/guides/ingress/).

**Features**
- HTTP
- [Single Service Ingress](/docs/guides/ingress/http/single-service.md)
- [Name and Path based virtual hosting](/docs/guides/ingress/http/named-virtual-hosting.md)
Expand Down
7 changes: 3 additions & 4 deletions docs/guides/_index.md
@@ -1,11 +1,10 @@
---
title: Guides
description: Voyager Guides
title: Guides | Voyager
menu:
product_voyager_5.0.0-rc.10:
product_voyager_5.0.0-rc.11:
identifier: guides
name: Guides
weight: 40
pre: dropdown
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
---
27 changes: 14 additions & 13 deletions docs/guides/certificate/README.md
@@ -1,35 +1,36 @@
---
title: Certificate | Voyager
menu:
product_voyager_5.0.0-rc.10:
identifier: certificate-readme
product_voyager_5.0.0-rc.11:
identifier: readme-certificate
name: Readme
parent: certificate
parent: certificate-guides
weight: -1
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: guides
url: /products/voyager/5.0.0-rc.10/guides/certificate/
url: /products/voyager/5.0.0-rc.11/guides/certificate/
aliases:
- /products/voyager/5.0.0-rc.10/guides/certificate/README/
- /products/voyager/5.0.0-rc.11/guides/certificate/README/
---

# Certificate
# Guides

Voyager comes with a built-in certificate manager that can issue free TLS/SSL certificates from Let's Encrypt. Voyager uses a Custom Resource Definition called `Certificate` to declaratively manage and issue certificates from Let's Encrypt.
Guides show you how to use Voyager's built-in certificate manager to issue free TLS/SSL certificates from Let's Encrypt.

## Features
- Provision free TLS certificates from Let's Encrypt.
- Manage certificates declaratively using a Kubernetes Custom Resource Definition (CRD).
- Domain validation using ACME http-01 and dns-01 challenges.
- Support for many popular [DNS providers](/docs/guides/certificate/providers.md).
- Support for many popular [DNS providers](/docs/guides/certificate/dns/providers.md).
- Auto Renew certificates.
- Use issued certificates with Ingress to secure communications.

## Next Steps
- [Issue Let's Encrypt certificate using HTTP-01 challenge](/docs/guides/certificate/http.md)
- [Issue Let's Encrypt certificate using HTTP-01 challenge](/docs/guides/certificate/http/overview.md)
- DNS-01 chanllege providers
- [Issue Let's Encrypt certificate using AWS Route53](/docs/guides/certificate/route53.md)
- [Issue Let's Encrypt certificate using Google Cloud DNS](/docs/guides/certificate/google-cloud.md)
- [Supported DNS Challenge Providers](/docs/guides/certificate/providers.md)
- [Issue Let's Encrypt certificate using AWS Route53](/docs/guides/certificate/dns/route53.md)
- [Issue Let's Encrypt certificate using Google Cloud DNS](/docs/guides/certificate/dns/google-cloud.md)
- [Supported DNS Challenge Providers](/docs/guides/certificate/dns/providers.md)
- [Deleting Certificate](/docs/guides/certificate/delete.md)
- [Frequently Asked Questions](/docs/guides/certificate/faq.md)
6 changes: 3 additions & 3 deletions docs/guides/certificate/_index.md
@@ -1,10 +1,10 @@
---
title: Certificate
menu:
product_voyager_5.0.0-rc.10:
identifier: certificate
product_voyager_5.0.0-rc.11:
identifier: certificate-guides
name: Certificate
parent: guides
weight: 80
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
---
15 changes: 10 additions & 5 deletions docs/guides/certificate/delete.md
@@ -1,30 +1,35 @@
---
title: Delete Certificate | Voyager
menu:
product_voyager_5.0.0-rc.10:
identifier: certificate-delete
product_voyager_5.0.0-rc.11:
identifier: delete-certificate
name: Delete
parent: certificate
weight: 60
parent: certificate-guides
weight: 20
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
menu_name: product_voyager_5.0.0-rc.11
section_menu_id: guides
---

# Deleting Certificate

Deleting a Kubernetes `Certificate` object will only delete the certificate CRD from Kubernetes.
It will not delete the obtained certificate and user account secret from Kubernetes. User have to manually delete these secrets for complete cleanup.

- Delete Certificate crd.

```console
kubectl delete certificate.voyager.appscode.com test-cert
```

- Delete Obtained Let's Encrypt tls certificate

```console
kubectl delete secret tls-test-cert
```

- Delete Let's Encrypt user account `Secret`

```console
kubectl delete secret test-user-secret
```

0 comments on commit e337755

Please sign in to comment.