Skip to content

Commit 26b4ca9

Browse files
author
Marco Capuccini
committed
Marco's adds
1 parent a2ef997 commit 26b4ca9

8 files changed

+38
-84
lines changed

advanced_topics/advanced_topics_intro.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

advanced_topics/cloudflare-dns.rst

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
11
Cloudflare DNS Records
22
======================
3-
`Cloudflare <https://www.cloudflare.com>`_ runs one of the largest authoritative DNS networks in the world. With an average of a few milliseconds query speed, DNS updates happen within seconds.
3+
`Cloudflare <https://www.cloudflare.com>`_ runs one of the largest authoritative DNS networks in the world. In order to resolve domain names for exposed services, KubeNow can optionally configure the Cloudflare dynamic DNS service, so that a base domain name will resolve to the edge nodes (or the master node if no edge node is deployed).
44

5-
Thus in order to resolve domain names for the Kubenow exposed services, the deployment script adds a wildcard record to the Cloudflare dynamic DNS service, such that a configurable base domain name will resolve to either the edge nodes or the master node when enabled to be working as an edge node.
6-
7-
Cloudflare's settings can be changed within the `terraform.tfvars` created automatically when initializing a :doc:`deploy configuration directory <../getting_started/bootstrap>` by running::
8-
9-
kn init <your-provider> my_deployment
10-
11-
Precisely, here below can be found an example of the configuration lines to be optionally tweaked in case a user had a different, dedicated Cloudflare account::
5+
To configure the Cloudflare dynamic DNS service, it is sufficient to uncomment the following lines in the ``terraform.tfvars`` file, specifying credentials, domain and subdomain::
126

137
# Cloudflare configuration (optional)
14-
# use_cloudflare = "true"
15-
# cloudflare_email = "your-cloudflare-email"
16-
# cloudflare_token = "your-cloudflare-token"
17-
# cloudflare_domain = "your-domain-name"
18-
# cloudflare_subdomain = "your-subdomain-name"
19-
20-
Thus it suffices to just decomment these lines and modify the above placeholders with others Cloudflare settings. Nevertheless, since for entry-level users it can be difficult to reserve a domain name and set it up with Cloudflare, it is possible to use NIP.IO instead.
21-
22-
NIP.IO provides for an easy mechanism to resolve domain names without needing any configuration (e.g., foo.10.0.0.1.nip.io maps to 10.0.0.1, bar.10.0.0.2.nip.io maps to 10.0.0.2, etc.).
8+
use_cloudflare = "true"
9+
cloudflare_email = "your-cloudflare-email"
10+
cloudflare_token = "your-cloudflare-token"
11+
cloudflare_domain = "your-domain-name"
12+
cloudflare_subdomain = "your-subdomain-name"

advanced_topics/cloudflare-proxied-dns.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Cloudflare: Proxied Traffic
2+
===========================
3+
Incoming container traffic can be optionally proxied through the `Cloudflare <https://www.cloudflare.com>`_ servers. When operating in this mode Cloudflare provides HTTPS for container services, and it protects against distributed denial of service, customer data breach and malicious bot abuse.
4+
5+
To enable Cloudflare proxied traffic, it is sufficient to uncomment the following lines in the ``terraform.tfvars`` file, specifying DNS records to be proxied::
6+
7+
# Cloudflare proxy (optional)
8+
cloudflare_proxied = "true"
9+
cloudflare_record_texts = ["record1","record2",...] # Warn: wildcards are not supported when using proxied records

advanced_topics/edge-nodes.rst

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
Edge Nodes
22
==========
3-
Edge nodes are specialized service nodes with an associated public IP address, and they act as reverse proxies, and load balancers, for the services that are exposed to the Internet. This behavior is implemented using `Traefik <https://traefik.io>`_ .
3+
Edge nodes are specialized service nodes with an associated public IP address, and they run `Traefik <https://traefik.io>`_ acting as reverse proxies, and load balancers, for the services that are exposed to the Internet. In the default settings, we don't deploy any edge node enabling the reverse proxy logic in the master node instead. However, in production settings we recommend to deploy one or more edge nodes to reduce the load in the master.
44

5-
However, when IP addresses are particularly scarce, it is possible to not deploy any edge node, and to use the master node as reverse proxy instead.
5+
To deploy edge nodes, it is sufficient to uncomment the following lines in the ``terraform.tfvars`` file, and to set the desired number of edge nodes, along with an available instance flavor::
66

7-
Edge nodes' settings can be changed within the `terraform.tfvars` created automatically when initializing a :doc:`deploy configuration directory <../getting_started/bootstrap>` by running::
8-
9-
kn init <your-provider> my_deployment
10-
11-
Precisely, here below can be found an example of the configuration lines to be optionally tweaked::
7+
# Master configuration (mandatory in general, above all for single-server setup)
8+
master_flavor = "your-master-flavor"
9+
master_as_edge = "false"
1210

1311
# Edge configuration
14-
# edge_count = "2"
15-
# edge_flavor = "your-edge-flavor"
16-
17-
Thus it suffices to just decomment these lines and modify the above placeholders with the desired number of edge nodes and the pick a flavor among the ones available via the used provider's.
12+
edge_count = "2"
13+
edge_flavor = "your-edge-flavor"
14+
15+
Please notice that we set ``master_as_edge = "false"`` to disable Traefik in the master node.
Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
11
GlusterFS Nodes
22
===============
3-
Storage nodes are specialized nodes too. They run **only** the shared distributed file system, and they are attached to a block storage volume to provide additional capacity. The shared file system is implemented by `GlusterFS <https://www.gluster.org>`_ and `Heketi <https://github.com/heketi/heketi>`_ .
4-
The two frameworks enable user applications for provisioning shared volumes seamlessly, trough the standard `Kubernetes API <https://kubernetes.io/>`_ .
3+
GlusterFS nodes are specialized service nodes. They run only `GlusterFS <https://www.gluster.org>`_ and they are attached to a block storage volume to provide additional capacity. In the default settings, we don't deploy GlusterFS nodes, as it is not required in many use cases. However, GlusterFS can be particularly convenient when a distributed file system is needed for container synchronization.
54

6-
GlusterFS nodes settings can be changed within the `terraform.tfvars` created automatically when initializing a :doc:`deploy configuration directory <../getting_started/bootstrap>` by running::
7-
8-
kn init <your-provider> my_deployment
9-
10-
Precisely, here below can be found an example of the configuration lines to be tweaked optionally if need be::
5+
To deploy GlusterFS nodes, it is sufficient to uncomment the following lines in the ``terraform.tfvars`` file, and to set the desired number of edge nodes, along with an available instance flavor and block storage disk size::
116

127
# Gluster configuration
13-
# glusternode_count = "1"
14-
# glusternode_flavor = "your-glusternode-flavor"
15-
# glusternode_extra_disk_size = "200" # Size in GB
16-
17-
As you may notice, these lines are commented by default thus leaving a user freedom of choosing custom solutions for a shared distributed file system if need be (which most of the time is actually the case for distributed microservice-oriented applications).
8+
glusternode_count = "1"
9+
glusternode_flavor = "your-glusternode-flavor"
10+
glusternode_extra_disk_size = "200" # Size in GB
Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
1-
Single Node Deployments
1+
Single-Node Deployments
22
=======================
3-
For single-server setups, it is possible to deploy the master node only, and enable it for service scheduling.
3+
When resources are scarce, or for testing purpose, KubeNow enables single-node deployments. In fact, it is possible to deploy the master node only, which will automatically enabled for service scheduling.
44

5-
This configuration can be enabled within the `terraform.tfvars` created automatically when initializing a :doc:`deploy configuration directory <../getting_started/bootstrap>` by running::
6-
7-
kn init <your-provider> my_deployment
8-
9-
Precisely you can achieve this by commenting all the lines for the other instance type (i.e. edge node, gluster node and worker node) but the master one as shown below::
5+
You can achieve this by commenting all of the lines for the other instance types (i.e. edge node, gluster node and worker node) in the ``terraform.tfvars`` file, leaving the master node only as it is shown below::
106

117
# Master configuration (mandatory in general, above all for single-server setup)
128
master_flavor = "your-master-flavor"
139
master_as_edge = "true"
1410

1511
# Node configuration
16-
#node_count = "3"
17-
#node_flavor = "your-node-flavor"
12+
# node_count = "3"
13+
# node_flavor = "your-node-flavor"
1814

1915
# Edge configuration
2016
# edge_count = "2"
@@ -24,14 +20,3 @@ Precisely you can achieve this by commenting all the lines for the other instanc
2420
# glusternode_count = "1"
2521
# glusternode_flavor = "your-glusternode-flavor"
2622
# glusternode_extra_disk_size = "200" # Size in GB
27-
28-
# Cloudflare configuration (optional)
29-
# use_cloudflare = "true"
30-
# cloudflare_email = "your-cloudflare-email"
31-
# cloudflare_token = "your-cloudflare-token"
32-
# cloudflare_domain = "your-domain-name"
33-
# cloudflare_subdomain = "your-subdomain-name"
34-
35-
# Cloudflare proxy (optional)
36-
# cloudflare_proxied = "true"
37-
# cloudflare_record_texts = ["record1","record2",...] # Warn: wildcards are not supported when using proxied records

index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,16 @@ Welcome to KubeNow's documentation! This is a place where we aim to help you to
1919
troubleshoot/trouble-os
2020
troubleshoot/trouble-kubernetes
2121
troubleshoot/trouble-misc
22-
22+
2323
.. toctree::
2424
:maxdepth: 2
2525
:caption: Advanced Topics
2626

27-
advanced_topics/advanced_topics_intro
28-
advanced_topics/cloudflare-dns
29-
advanced_topics/cloudflare-proxied-dns
3027
advanced_topics/edge-nodes
3128
advanced_topics/glusterfs-nodes
3229
advanced_topics/single-node-deployments
30+
advanced_topics/cloudflare-dns
31+
advanced_topics/cloudflare-proxied
3332

3433
.. toctree::
3534
:maxdepth: 2

0 commit comments

Comments
 (0)