Skip to content

Commit

Permalink
Reorganize docs for hosting on product site (#798)
Browse files Browse the repository at this point in the history
  • Loading branch information
tamalsaha committed Jan 4, 2018
1 parent a262861 commit 0afab18
Show file tree
Hide file tree
Showing 64 changed files with 523 additions and 611 deletions.
24 changes: 14 additions & 10 deletions docs/CONTRIBUTING.md
Expand Up @@ -5,17 +5,20 @@ menu:
product_voyager_5.0.0-rc.10:
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/
section_menu_id: welcome
url: /products/voyager/5.0.0-rc.10/welcome/contributing/
aliases:
- /products/voyager/5.0.0-rc.10/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
17 changes: 9 additions & 8 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
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/
section_menu_id: welcome
url: /products/voyager/5.0.0-rc.10/welcome/
aliases:
- /products/voyager/5.0.0-rc.10/
- /products/voyager/5.0.0-rc.10/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
4 changes: 2 additions & 2 deletions docs/_index.md
Expand Up @@ -3,8 +3,8 @@ title: Docs | Voyager
description: Voyager Docs
menu:
product_voyager_5.0.0-rc.10:
identifier: getting-started
name: Getting Started
identifier: welcome
name: Welcome
weight: 10
menu_name: product_voyager_5.0.0-rc.10
---
10 changes: 6 additions & 4 deletions docs/acknowledgement.md
Expand Up @@ -5,12 +5,14 @@ menu:
product_voyager_5.0.0-rc.10:
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/
section_menu_id: welcome
url: /products/voyager/5.0.0-rc.10/welcome/acknowledgement/
aliases:
- /products/voyager/5.0.0-rc.10/acknowledgement/
---

# Acknowledgement
Expand Down
5 changes: 3 additions & 2 deletions docs/concepts/README.md
Expand Up @@ -13,7 +13,8 @@ url: /products/voyager/5.0.0-rc.10/concepts/
aliases:
- /products/voyager/5.0.0-rc.10/concepts/README/
---

# Concepts

Concepts help you learn about the different parts of the Voyager system and the abstractions it uses.
Concepts help you learn about the different parts of the Voyager and the abstractions it uses.

- [Overview](/docs/concepts/overview.md). Provides a conceptual introduction to Voyager, including the problems it solves and its high-level architecture.
14 changes: 0 additions & 14 deletions docs/concepts/ingress-class.md
@@ -1,17 +1,3 @@
---
title: Ingress Class | Voyager
description: Ingress Class
menu:
product_voyager_5.0.0-rc.10:
identifier: ingress-class
name: Ingress Class
parent: concepts
weight: 40
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
section_menu_id: concepts
---

# Running voyager alongside with other ingress controller

Voyager can be configured to handle default kubernetes ingress or only ingress.appscode.com. voyager can also be run
Expand Down
49 changes: 18 additions & 31 deletions docs/concepts/overview.md
@@ -1,19 +1,14 @@
---
title: Overview | Voyager
description: Overview of Voyager
menu:
product_voyager_5.0.0-rc.10:
identifier: overview-voyager
identifier: overview-concepts
name: Overview
parent: getting-started
weight: 20
parent: concepts
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/
aliases:
- /products/voyager/5.0.0-rc.10/
- /products/voyager/5.0.0-rc.10/README/
section_menu_id: concepts
---

# Voyager
Expand All @@ -23,22 +18,20 @@ Voyager is a [HAProxy](http://www.haproxy.org/) backed [secure](#certificate) L7

## 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/).
This also support configurable application ports with all the options available in a standard Kubernetes [Ingress](https://kubernetes.io/docs/concepts/services-networking/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)
- [Exposing Service via Ingress](/docs/guides/ingress/http/single-service.md)
- [Virtual Hosting](/docs/guides/ingress/http/virtual-hosting.md)
- [Supports Loadbalancer Source Range](/docs/guides/ingress/http/source-range.md)
- [URL and Request Header Re-writing](/docs/guides/ingress/http/header-rewrite.md)
- [URL and Request Header Re-writing](/docs/guides/ingress/http/rewrite-rules.md)
- [Enable CORS](/docs/guides/ingress/http/cors.md)
- [Custom HTTP Port](/docs/guides/ingress/http/custom-http-port.md)
- [Supports redirects/DNS resolution for `ExternalName` type service](/docs/guides/ingress/http/external-svc.md)
- [Using External Service as Ingress Backend](/docs/guides/ingress/http/external-svc.md)
- [HSTS](/docs/guides/ingress/http/hsts.md)
- [Simple Fanout](/docs/guides/ingress/http/simple-fanout.md)
- [Route Traffic to StatefulSet Pods Based on Host Name](/docs/guides/ingress/http/statefulset-pod.md)
- [Forward Traffic to StatefulSet Pods](/docs/guides/ingress/http/statefulset-pod.md)
- [Configure Sticky session to Backends](/docs/guides/ingress/http/sticky-session.md)
- [Weighted Loadbalancing for Canary Deployment](/docs/guides/ingress/http/weighted.md)
- [Blue Green Deployments using weighted Loadbalancing](/docs/guides/ingress/http/weighted.md)
- TLS/SSL
- [TLS Termination](/docs/guides/ingress/tls/tls.md)
- [Backend TLS](/docs/guides/ingress/tls/backend-tls.md)
Expand All @@ -49,29 +42,23 @@ This also support configurable application ports with all the options available
- [Customize generated HAProxy config via BackendRule](/docs/guides/ingress/configuration/backend-rule.md) (can be used for [http rewriting](https://www.haproxy.com/doc/aloha/7.0/haproxy/http_rewriting.html), add [health checks](https://www.haproxy.com/doc/aloha/7.0/haproxy/healthchecks.html), etc.)
- [Apply Frontend Rules](/docs/guides/ingress/configuration/frontend-rule.md)
- [Supported Annotations](/docs/guides/ingress/configuration/annotations.md)
- [Bind to address](/docs/guides/ingress/configuration/bind-address.md)
- [Specify NodePort](/docs/guides/ingress/configuration/node-port.md)
- [Configure global options](/docs/guides/ingress/configuration/configure-options.md)
- [Configure Custom Timeouts for HAProxy](/docs/guides/ingress/configuration/configure-timeouts.md)
- [Configure global options](/docs/guides/ingress/configuration/default-options.md)
- [Configure Custom Timeouts for HAProxy](/docs/guides/ingress/configuration/default-timeouts.md)
- [Using Custom HAProxy Templates](/docs/guides/ingress/configuration/custom-templates.md)
- External DNS
- [Configuring DNS](/docs/guides/ingress/dns/external-dns.md)
- Security
- [Configure Basic Auth for HTTP Backends](/docs/guides/ingress/security/basic-auth.md)
- [TLS Authentication](/docs/guides/ingress/security/tls-auth.md)
- [Configuring RBAC](/docs/guides/ingress/security/rbac.md)
- [Running Voyager per Namespace](/docs/guides/ingress/security/restrict-namespace.md)
- Monitoring
- [Exposing HAProxy Stats](/docs/guides/ingress/monitoring/stats-and-prometheus.md)
- [Replicas and Horizontal Pod Autoscaling](/docs/guides/ingress/replicas-and-autoscaling.md)
- [Placement of HAProxy Pods](/docs/guides/ingress/pod-placement.md)
- [Debugging Ingress](/docs/guides/ingress/debugging.md)
- [Exposing HAProxy Stats](/docs/guides/ingress/monitoring/stats.md)
- [Scaling Ingress](/docs/guides/ingress/scaling.md)
- [Placement of Ingress Pods](/docs/guides/ingress/pod-placement.md)


## Certificate
Voyager can automaticallty provision and refresh SSL certificates issued from Let's Encrypt using a custom Kubernetes [Certificate](/docs/guides/certificate) resource.

**Features**
Voyager can automagically provision and refresh SSL certificates issued from Let's Encrypt using a custom Kubernetes [Certificate](/docs/guides/certificate) resource.

- Provision free TLS certificates from Let's Encrypt,
- Manage issued certificates using a Kubernetes Third Party Resource,
- Domain validation using ACME dns-01 challenges,
Expand Down
3 changes: 1 addition & 2 deletions docs/guides/_index.md
@@ -1,6 +1,5 @@
---
title: Guides
description: Voyager Guides
title: Guides | Voyager
menu:
product_voyager_5.0.0-rc.10:
identifier: guides
Expand Down
19 changes: 10 additions & 9 deletions docs/guides/certificate/README.md
@@ -1,9 +1,10 @@
---
title: Certificate | Voyager
menu:
product_voyager_5.0.0-rc.10:
identifier: certificate-readme
identifier: readme-certificate
name: Readme
parent: certificate
parent: certificate-guides
weight: -1
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
Expand All @@ -13,23 +14,23 @@ aliases:
- /products/voyager/5.0.0-rc.10/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)
2 changes: 1 addition & 1 deletion docs/guides/certificate/_index.md
Expand Up @@ -2,7 +2,7 @@
title: Certificate
menu:
product_voyager_5.0.0-rc.10:
identifier: certificate
identifier: certificate-guides
name: Certificate
parent: guides
weight: 80
Expand Down
11 changes: 8 additions & 3 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
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
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
```
11 changes: 11 additions & 0 deletions docs/guides/certificate/dns/_index.md
@@ -0,0 +1,11 @@
---
title: DNS Challenger
description: DNS Challenger
menu:
product_voyager_5.0.0-rc.10:
identifier: dns-certificate
parent: certificate-guides
name: DNS Challenger
weight: 15
menu_name: product_voyager_5.0.0-rc.10
---
@@ -1,10 +1,12 @@
---
title: Issue Let's Encrypt certificate using Google Cloud DNS
description: Issue Let's Encrypt certificate using Google Cloud DNS in Kubernetes
menu:
product_voyager_5.0.0-rc.10:
identifier: certificate-google-cloud
identifier: googlecloud-dns
name: Google Cloud
parent: certificate
weight: 30
parent: dns-certificate
weight: 15
product_name: voyager
menu_name: product_voyager_5.0.0-rc.10
section_menu_id: guides
Expand All @@ -24,7 +26,7 @@ Server Version: v1.8.4-gke.0

## Deploy Voyager operator

Deploy Voyager operator following instructions [here](/docs/install.md).
Deploy Voyager operator following instructions [here](/docs/setup/install.md).

```console
# install without RBAC
Expand Down

0 comments on commit 0afab18

Please sign in to comment.