Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename tasks to guides #764

Merged
merged 1 commit into from Dec 18, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -7,11 +7,11 @@ 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](/docs/tasks/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/tasks/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/).

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

## Supported Versions
Please pick a version of Voyager that matches your Kubernetes installation.
Expand Down
8 changes: 4 additions & 4 deletions chart/stable/voyager/values.yaml
Expand Up @@ -19,16 +19,16 @@ exporter:
# imagePullSecrets:
# - name: myRegistryKeySecretName
## Specify a imagePullPolicy
## ref: http://kubernetes.io/docs/tasks/images/#pre-pulling-images
## ref: http://kubernetes.io/docs/guides/images/#pre-pulling-images
##
imagePullPolicy: IfNotPresent
## Use cloud provider here. Read details https://github.com/appscode/voyager/blob/master/docs/tasks/README.md
## Use cloud provider here.
cloudProvider:
## The path to the cloud provider configuration file. Empty string for no configuration file.
## ie. for azure use /etc/kubernetes/azure.json
cloudConfig: ''
## Installs voyager operator as critical addon
## https://kubernetes.io/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods/
## https://kubernetes.io/docs/guides/administer-cluster/guaranteed-scheduling-critical-addon-pods/
criticalAddon: false
## Log level for voyager
logLevel: 3
Expand All @@ -37,7 +37,7 @@ persistence:
hostPath: /etc/kubernetes

## Node labels for pod assignment
## Ref: https://kubernetes.io/docs/tasks/node-selection/
## Ref: https://kubernetes.io/docs/guides/node-selection/
##
nodeSelector: {}

Expand Down
5 changes: 1 addition & 4 deletions docs/README.md
Expand Up @@ -27,10 +27,7 @@ is where you can learn about what Voyager does and how it does it.
- [Setup](/docs/setup/). Setup contains instructions for installing
the Voyager in various cloud providers.

- Tasks. Tasks show you how to do a single directed activity with Voyager. These are organized under [Ingress](/docs/tasks/ingress) and [Certificate](/docs/tasks/certificate).

- [Guides](/docs/guides/). Guides are fully working stand-alone examples
intended to highlight a particular set of Voyager's features.
- [Guides](/docs/guides/). Guides show you how to perform tasks with Voyager. These are organized under [Ingress](/docs/guides/ingress) and [Certificate](/docs/guides/certificate).

- [Reference](/docs/reference/). Detailed exhaustive lists of
command-line options, configuration options, API definitions, and procedures.
Expand Down
72 changes: 36 additions & 36 deletions docs/concepts/overview.md
Expand Up @@ -22,54 +22,54 @@ 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/tasks/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/tasks/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/tasks/ingress/http/single-service.md)
- [Name and Path based virtual hosting](/docs/tasks/ingress/http/named-virtual-hosting.md)
- [Supports Loadbalancer Source Range](/docs/tasks/ingress/http/source-range.md)
- [URL and Request Header Re-writing](/docs/tasks/ingress/http/header-rewrite.md)
- [Enable CORS](/docs/tasks/ingress/http/cors.md)
- [Custom HTTP Port](/docs/tasks/ingress/http/custom-http-port.md)
- [Supports redirects/DNS resolution for `ExternalName` type service](/docs/tasks/ingress/http/external-svc.md)
- [HSTS](/docs/tasks/ingress/http/hsts.md)
- [Simple Fanout](/docs/tasks/ingress/http/simple-fanout.md)
- [Route Traffic to StatefulSet Pods Based on Host Name](/docs/tasks/ingress/http/statefulset-pod.md)
- [Configure Sticky session to Backends](/docs/tasks/ingress/http/sticky-session.md)
- [Weighted Loadbalancing for Canary Deployment](/docs/tasks/ingress/http/weighted.md)
- [Single Service Ingress](/docs/guides/ingress/http/single-service.md)
- [Name and Path based virtual hosting](/docs/guides/ingress/http/named-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)
- [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)
- [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)
- [Configure Sticky session to Backends](/docs/guides/ingress/http/sticky-session.md)
- [Weighted Loadbalancing for Canary Deployment](/docs/guides/ingress/http/weighted.md)
- TLS/SSL
- [TLS Termination](/docs/tasks/ingress/tls/tls.md)
- [Backend TLS](/docs/tasks/ingress/tls/backend-tls.md)
- [Supports AWS certificate manager](/docs/tasks/ingress/tls/aws-cert-manager.md)
- [TLS Termination](/docs/guides/ingress/tls/tls.md)
- [Backend TLS](/docs/guides/ingress/tls/backend-tls.md)
- [Supports AWS certificate manager](/docs/guides/ingress/tls/aws-cert-manager.md)
- TCP
- [TCP LoadBalancing](/docs/tasks/ingress/tcp/tcp.md)
- [TCP LoadBalancing](/docs/guides/ingress/tcp/tcp.md)
- Configuration
- [Customize generated HAProxy config via BackendRule](/docs/tasks/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/tasks/ingress/configuration/frontend-rule.md)
- [Supported Annotations](/docs/tasks/ingress/configuration/annotations.md)
- [Bind to address](/docs/tasks/ingress/configuration/bind-address.md)
- [Specify NodePort](/docs/tasks/ingress/configuration/node-port.md)
- [Configure global options](/docs/tasks/ingress/configuration/configure-options.md)
- [Configure Custom Timeouts for HAProxy](/docs/tasks/ingress/configuration/configure-timeouts.md)
- [Using Custom HAProxy Templates](/docs/tasks/ingress/configuration/custom-templates.md)
- [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)
- [Using Custom HAProxy Templates](/docs/guides/ingress/configuration/custom-templates.md)
- External DNS
- [Configuring DNS](/docs/tasks/ingress/dns/external-dns.md)
- [Configuring DNS](/docs/guides/ingress/dns/external-dns.md)
- Security
- [Configure Basic Auth for HTTP Backends](/docs/tasks/ingress/security/basic-auth.md)
- [TLS Authentication](/docs/tasks/ingress/security/tls-auth.md)
- [Configuring RBAC](/docs/tasks/ingress/security/rbac.md)
- [Running Voyager per Namespace](/docs/tasks/ingress/security/restrict-namespace.md)
- [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/tasks/ingress/monitoring/stats-and-prometheus.md)
- [Replicas and Horizontal Pod Autoscaling](/docs/tasks/ingress/replicas-and-autoscaling.md)
- [Placement of HAProxy Pods](/docs/tasks/ingress/pod-placement.md)
- [Debugging Ingress](/docs/tasks/ingress/debugging.md)
- [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)


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

**Features**
- Provision free TLS certificates from Let's Encrypt,
Expand Down
2 changes: 1 addition & 1 deletion docs/tasks/_index.md → docs/guides/_index.md
Expand Up @@ -3,7 +3,7 @@ title: Tutorials
description: Voyager Tutorials
menu:
product_voyager_5.0.0-rc.7:
identifier: tasks
identifier: guides
name: Tutorials
weight: 30
pre: dropdown
Expand Down
Expand Up @@ -7,10 +7,10 @@ menu:
weight: 10
product_name: voyager
menu_name: product_voyager_5.0.0-rc.7
section_menu_id: tasks
url: /products/voyager/5.0.0-rc.7/tasks/certificate/
section_menu_id: guides
url: /products/voyager/5.0.0-rc.7/guides/certificate/
aliases:
- /products/voyager/5.0.0-rc.7/tasks/certificate/README/
- /products/voyager/5.0.0-rc.7/guides/certificate/README/
---

# Certificate
Expand All @@ -21,15 +21,15 @@ Voyager comes with a built-in certificate manager that can issue free TLS/SSL ce
- 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/tasks/certificate/providers.md).
- Support for many popular [DNS providers](/docs/guides/certificate/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/tasks/certificate/http.md)
- [Issue Let's Encrypt certificate using HTTP-01 challenge](/docs/guides/certificate/http.md)
- DNS-01 chanllege providers
- [Issue Let's Encrypt certificate using AWS Route53](/docs/tasks/certificate/route53.md)
- [Issue Let's Encrypt certificate using Google Cloud DNS](/docs/tasks/certificate/google-cloud.md)
- [Supported DNS Challenge Providers](/docs/tasks/certificate/providers.md)
- [Deleting Certificate](/docs/tasks/certificate/delete.md)
- [Frequently Asked Questions](/docs/tasks/certificate/faq.md)
- [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)
- [Deleting Certificate](/docs/guides/certificate/delete.md)
- [Frequently Asked Questions](/docs/guides/certificate/faq.md)
Expand Up @@ -4,7 +4,7 @@ menu:
product_voyager_5.0.0-rc.7:
identifier: certificate
name: Certificate
parent: tasks
parent: guides
weight: 80
menu_name: product_voyager_5.0.0-rc.7
---
File renamed without changes.
Expand Up @@ -55,8 +55,8 @@ type: Opaque

### How can I distribute the issued ssl certificates?
There are several options:
- If you are trying to distribute the same ssl certificate across different namespaces of a cluster, you can use a tool like [kubed](https://github.com/appscode/kubed/blob/master/docs/tasks/config-syncer.md).
- If you want to distribute the issued certificates across different clusters, you can setup Voyager to issue certificates independently on each cluster. Please read the rate limiting restrictions for LE. The other option is to use [Kubernetes cluster federation](https://kubernetes.io/docs/tasks/administer-federation/secret/) but it might not be worth the trouble if this is your only usecase for cluster federation.
- If you are trying to distribute the same ssl certificate across different namespaces of a cluster, you can use a tool like [kubed](https://github.com/appscode/kubed/blob/master/docs/guides/config-syncer.md).
- If you want to distribute the issued certificates across different clusters, you can setup Voyager to issue certificates independently on each cluster. Please read the rate limiting restrictions for LE. The other option is to use [Kubernetes cluster federation](https://kubernetes.io/docs/guides/administer-federation/secret/) but it might not be worth the trouble if this is your only usecase for cluster federation.
- Just manually copy paste the `tls-***` secret to your destination cluster or namespace.


Expand Down
File renamed without changes.
Expand Up @@ -7,7 +7,7 @@ menu:
weight: 30
product_name: voyager
menu_name: product_voyager_5.0.0-rc.7
section_menu_id: tasks
section_menu_id: guides
---

# Supported DNS Challenge Providers
Expand All @@ -24,7 +24,7 @@ Please see the list of supported providers and the keys expected in credential p
- `AWS_SECRET_ACCESS_KEY`: The secret corresponding to the access key
- `AWS_HOSTED_ZONE_ID`: `Optional`. If AWS_HOSTED_ZONE_ID is not set, Voyager tries to determine the correct public hosted zone via the FQDN.

To learn about necessary IAM permissions, please see [here](https://github.com/appscode/voyager/blob/cert-doc/docs/tasks/certificate/route53.md#configure-iam-permissions).
To learn about necessary IAM permissions, please see [here](https://github.com/appscode/voyager/blob/cert-doc/docs/guides/certificate/route53.md#configure-iam-permissions).

### Microsoft Azure
- Provider: `azure` or `acs`
Expand Down Expand Up @@ -83,7 +83,7 @@ To learn about necessary IAM permissions, please see [here](https://github.com/a
- `GCE_PROJECT`: The name of the Google Cloud project to use
- `GOOGLE_SERVICE_ACCOUNT_JSON_KEY`: Service account json downloaded from Google Cloud console. This service account requires scope `https://www.googleapis.com/auth/ndev.clouddns.readwrite` to view and manage your DNS records hosted by Google Cloud DNS.

If you are running your cluster on Google Cloud (GKE or GCE), Voyager can use default service account associated with a VM. Please see [here](/docs/tasks/certificate/google-cloud.md#configure-service-account-permissions) for detailed instructions.
If you are running your cluster on Google Cloud (GKE or GCE), Voyager can use default service account associated with a VM. Please see [here](/docs/guides/certificate/google-cloud.md#configure-service-account-permissions) for detailed instructions.

### Linode
- Provider: `linode`
Expand Down Expand Up @@ -166,6 +166,6 @@ spec:
name: cert-kitecipro
```

For detailed tasks on how to issue SSL certificates using Voyager, please see below:
- [Issue Let's Encrypt certificate using AWS Route53](/docs/tasks/certificate/route53.md)
- [Issue Let's Encrypt certificate using Google Cloud DNS](/docs/tasks/certificate/google-cloud.md)
For detailed guides on how to issue SSL certificates using Voyager, please see below:
- [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)
File renamed without changes.