GITBOOK-66: Add note re space considerations to requirements and prerequisites

This commit is contained in:
James Carppe
2023-11-27 03:35:43 +00:00
committed by gitbook-bot
parent 7399397f95
commit aba7877bb2
3 changed files with 10 additions and 0 deletions

View File

@@ -98,6 +98,8 @@ If you find an issue with an unlisted configuration, before reporting a bug, upd
The Portainer Server requires persistent storage in order to maintain the database and configuration information it needs to function. The installation process provides a basic storage configuration for your platform. By default, both Docker and Kubernetes provide local (to the node) storage only, and if cluster-wide persistent storage is desired we recommend implementing it at the infrastructure level (for example, via NFS).
Additionally, you will want to ensure that your persistent storage for Portainer's data volume is right-sized for your needs. If you intend to use Portainer's Git deployment functionality for example, you will need to be aware that as part of the deployment from Git, Portainer will clone the remote repository locally to the Portainer data volume, which in the case of larger or multiple Git repos may consume significant amounts of disk space.
## Ports
In order to access the UI and API, and for the Portainer Server instance and the Portainer Agents to communicate, certain ports need to be accessible.

View File

@@ -93,6 +93,10 @@ When you're ready click **Deploy the stack**.
If your Compose file is hosted in a Git repository, you can deploy from there. From the menu select **Stacks**, click **Add stack**, then give the stack a descriptive name.
{% hint style="warning" %}
When a stack is deployed from Git, Portainer will clone the entire Git repository as part of the deployment process. Ensure you have enough free space to accommodate this.
{% endhint %}
<figure><img src="../../../.gitbook/assets/2.15-docker_add_stack_git.gif" alt=""><figcaption></figcaption></figure>
Select **Git Repository** then enter information about your Git repo.

View File

@@ -22,6 +22,10 @@ If you want to use namespaces defined in your manifest defines the namespace(s)
Use the provided fields to enter the details of your Git repository containing your Kubernetes manifests.
{% hint style="warning" %}
When an application is deployed from Git, Portainer will clone the entire Git repository as part of the deployment process. Ensure you have enough free space to accommodate this.
{% endhint %}
| Field/Option | Overview |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authentication | Toggle this on if your repository requires authentication. |