From ab54cf8fb97fbc7895fdc13614b5ebfee9a18752 Mon Sep 17 00:00:00 2001 From: James Carppe Date: Wed, 27 Apr 2022 03:50:13 +0000 Subject: [PATCH] GitBook: [#26] Merge Portainer Concepts FAQ entries into a single page --- SUMMARY.md | 5 +--- admin/licenses.md | 2 +- ...-for-licensing-purposes.md => concepts.md} | 29 ++++++++++++++----- faq/concepts/README.md | 2 -- ...what-information-does-portainer-collect.md | 5 ---- .../what-is-portainers-architecture.md | 5 ---- faq/upgrading/how-do-i-upgrade-my-license.md | 2 +- 7 files changed, 24 insertions(+), 26 deletions(-) rename faq/{concepts/what-is-a-node-for-licensing-purposes.md => concepts.md} (70%) delete mode 100644 faq/concepts/README.md delete mode 100644 faq/concepts/what-information-does-portainer-collect.md delete mode 100644 faq/concepts/what-is-portainers-architecture.md diff --git a/SUMMARY.md b/SUMMARY.md index a62e9706..95ceb1ff 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -202,10 +202,7 @@ ## Frequently Asked Questions -* [Portainer Concepts](faq/concepts/README.md) - * [What is Portainer's architecture?](faq/concepts/what-is-portainers-architecture.md) - * [What is a "node" for licensing purposes?](faq/concepts/what-is-a-node-for-licensing-purposes.md) - * [What information does Portainer collect?](faq/concepts/what-information-does-portainer-collect.md) +* [Portainer Concepts](faq/concepts.md) * [Installing](faq/installing/README.md) * [How do I install Portainer BE?](faq/installing/how-do-i-install-portainer.md) * [Can I run Portainer on my configuration?](faq/installing/can-i-run-portainer-on-my-configuration.md) diff --git a/admin/licenses.md b/admin/licenses.md index de35cff1..0945aa6e 100644 --- a/admin/licenses.md +++ b/admin/licenses.md @@ -1,6 +1,6 @@ # Licenses -Licensing in Portainer Business Edition is based on the [number of nodes](../faq/concepts/what-is-a-node-for-licensing-purposes.md) you are managing. +Licensing in Portainer Business Edition is based on the [number of nodes](../faq/concepts.md#what-is-a-node-for-licensing-purposes) you are managing. From the menu select **Licenses**. The **License Information** section summarizes information about your license including how many nodes it covers and how many nodes are currently being used, as well as the license expiry date. diff --git a/faq/concepts/what-is-a-node-for-licensing-purposes.md b/faq/concepts.md similarity index 70% rename from faq/concepts/what-is-a-node-for-licensing-purposes.md rename to faq/concepts.md index a4eb3950..cb1fca8a 100644 --- a/faq/concepts/what-is-a-node-for-licensing-purposes.md +++ b/faq/concepts.md @@ -1,8 +1,16 @@ -# What is a "node" for licensing purposes? +# Portainer Concepts + +## What is Portainer's architecture? + +Want to know how Portainer hangs together? Our architectural diagram shows you in detail. + +![](../.gitbook/assets/portainer-architecture-detailed.png) + +## What is a "node" for licensing purposes? With Portainer Business Edition, pricing is on a "per-node" basis. But what constitutes a node? -## Docker +### Docker For Docker, we consider anything that runs Portainer, whether that be Portainer Server or Portainer Agent, as a node. This is important to remember as on clustered environments like Docker Swarm the Portainer Agent will be running on each server in the cluster and therefore count towards your number of licenses. @@ -12,13 +20,13 @@ If you are managing a Swarm cluster without using the Portainer Agent, those nod Let's look at a few examples. Say you are running a small setup consisting of three Docker Standalone servers. One of these servers is hosting the Portainer Server container, and the other two are managed from the Portainer Server container using the Portainer Agent: -![](../../.gitbook/assets/licensing-docker-standalone.png) +![](../.gitbook/assets/licensing-docker-standalone.png) In this scenario, Portainer is running in three places (one Server and two Agents) so would need a 3 node license. Now, for Docker Swarm let's imagine a setup with one manager node (`manager01`) and two worker nodes (`swarm01` and `swarm02`): -![](../../.gitbook/assets/licensing-docker-swarm.png) +![](../.gitbook/assets/licensing-docker-swarm.png) Portainer Server is running on the manager node, and the agent is running on all three nodes across the swarm. Therefore, this would also require a 3 node license. @@ -26,21 +34,26 @@ Portainer Server is running on the manager node, and the agent is running on all If a node is running both the Portainer Server and the Portainer Agent, this is only counted as one node for licensing purposes. {% endhint %} -## Kubernetes +### Kubernetes Kubernetes by nature works differently to Docker, so licensing does too. Let's consider a Kubernetes cluster with one master node and two worker nodes: -![](../../.gitbook/assets/licensing-kubernetes.png) +![](../.gitbook/assets/licensing-kubernetes.png) With Kubernetes, the Portainer Agent has the ability to access the Kubernetes API in order to manage the entire cluster. This access is used to determine the number of nodes in the cluster (three in this case) which then gives you the required number of licenses (three). -## Multiple environments +### Multiple environments But what if you're running multiple environments? Let's combine what we have above into something more complex: one "management" server (running Docker Standalone) that manages a three node Docker Swarm and a three node Kubernetes cluster: -![](../../.gitbook/assets/licensing-combo.png) +![](../.gitbook/assets/licensing-combo.png) You'll note the Portainer Server is only running in one place - the management server. The rest of the cluster is running the Portainer Agent. With three Docker Swarm nodes and three nodes in the Kubernetes cluster that's 6 nodes, plus the management node makes 7, for a 7 node license. Hopefully that has made the node licensing model easier to understand. If you're still confused, feel free to [reach out to our success team](mailto:success@portainer.io) who can help put a quote together for your specific needs. +## What information does Portainer collect? + +So we focus our efforts in the right places, we need to know which features get used most often. We use Matamo Analytics to get this information. Matamo Analytics is hosted in Germany and is fully [GDPR-compliant](https://gdpr.eu). + +When Portainer first starts, you are given the option to disable analytics. If you choose not to disable analytics, we will collect anonymous usage statistics (as per our [privacy policy](https://www.portainer.io/privacy-policy)). We do not store or send any personally identifiable information at any time, and we only use the data collected to improve Portainer. diff --git a/faq/concepts/README.md b/faq/concepts/README.md deleted file mode 100644 index 43f7dd01..00000000 --- a/faq/concepts/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Portainer Concepts - diff --git a/faq/concepts/what-information-does-portainer-collect.md b/faq/concepts/what-information-does-portainer-collect.md deleted file mode 100644 index 7ee78d77..00000000 --- a/faq/concepts/what-information-does-portainer-collect.md +++ /dev/null @@ -1,5 +0,0 @@ -# What information does Portainer collect? - -So we focus our efforts in the right places, we need to know which features get used most often. We use Matamo Analytics to get this information. Matamo Analytics is hosted in Germany and is fully [GDPR-compliant](https://gdpr.eu). - -When Portainer first starts, you are given the option to disable analytics. If you choose not to disable analytics, we will collect anonymous usage statistics (as per our [privacy policy](https://www.portainer.io/privacy-policy)). We do not store or send any personally identifiable information at any time, and we only use the data collected to improve Portainer. diff --git a/faq/concepts/what-is-portainers-architecture.md b/faq/concepts/what-is-portainers-architecture.md deleted file mode 100644 index 957da2b3..00000000 --- a/faq/concepts/what-is-portainers-architecture.md +++ /dev/null @@ -1,5 +0,0 @@ -# What is Portainer's architecture? - -Want to know how Portainer hangs together? Our architectural diagram shows you in detail. - -![](../../.gitbook/assets/portainer-architecture-detailed.png) diff --git a/faq/upgrading/how-do-i-upgrade-my-license.md b/faq/upgrading/how-do-i-upgrade-my-license.md index 7eeacee8..008f81e5 100644 --- a/faq/upgrading/how-do-i-upgrade-my-license.md +++ b/faq/upgrading/how-do-i-upgrade-my-license.md @@ -1,5 +1,5 @@ # How do I upgrade my license? -Licensing in Portainer Business Edition is based on the [number of nodes](../concepts/what-is-a-node-for-licensing-purposes.md) you are managing. If you want to manage additional clusters or nodes and your license doesn't cover the additional nodes, you will need to upgrade your license. +Licensing in Portainer Business Edition is based on the [number of nodes](broken-reference) you are managing. If you want to manage additional clusters or nodes and your license doesn't cover the additional nodes, you will need to upgrade your license. To upgrade your license, please get in touch with [our success team](mailto:success@portainer.io).