mirror of
https://github.com/portainer/portainer-docs.git
synced 2026-03-27 12:58:32 +07:00
GITBOOK-10: Helm details update, mTLS update, version bumps
This commit is contained in:
James Carppe
committed by
gitbook-bot
gitbook-bot
parent
1a70fbdbfc
commit
48d5000c8e
BIN
.gitbook/assets/2.29-admin-settings-edge-settings.png
Normal file
BIN
.gitbook/assets/2.29-admin-settings-edge-settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
BIN
.gitbook/assets/2.29-admin-user-roles.png
Normal file
BIN
.gitbook/assets/2.29-admin-user-roles.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 97 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
.gitbook/assets/2.29-kubernetes-applications-inspect-helm.gif
Normal file
BIN
.gitbook/assets/2.29-kubernetes-applications-inspect-helm.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 732 KiB |
BIN
.gitbook/assets/2.29-kubernetes-applications-inspect-helm.png
Normal file
BIN
.gitbook/assets/2.29-kubernetes-applications-inspect-helm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 78 KiB |
@@ -140,7 +140,6 @@
|
||||
* [Manage a namespace](user/kubernetes/namespaces/manage.md)
|
||||
* [Manage access to a namespace](user/kubernetes/namespaces/access.md)
|
||||
* [Remove a namespace](user/kubernetes/namespaces/remove.md)
|
||||
* [Helm](user/kubernetes/helm.md)
|
||||
* [Applications](user/kubernetes/applications/README.md)
|
||||
* [Add a new application using a form](user/kubernetes/applications/add.md)
|
||||
* [Add a new application using code](user/kubernetes/applications/manifest.md)
|
||||
|
||||
@@ -18,12 +18,12 @@ In this section you can use the following options to enable and configure Edge C
|
||||
| Portainer API server URL | <p>Enter the default URL and port of your Portainer Server instance as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this.<br>This value can be overridden when manually deploying an Edge Agent.<br>This feature is only available in Portainer Business Edition.</p> |
|
||||
| Portainer tunnel server address | <p>Enter the default address and port of your Portainer Server instance's tunnel server as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this.<br>In most cases, this will be the same address as the Portainer API server URL, but without the protocol and on port <code>8000</code>.<br>This value can be overridden when manually deploying an Edge Agent.<br>This feature is only available in Portainer Business Edition. For Community Edition users, refer to <a href="https://github.com/portainer/portainer/issues/6251">this GitHub issue</a>.</p> |
|
||||
| Use separate mTLS cert | <p>Enable this toggle to use a separate mTLS certificate for Edge Agent communication. With this option disabled, Edge Agents will use the same TLS certificate as the Portainer UI.<br>For more information on mTLS read our <a href="../../advanced/mtls.md">advanced documentation</a>.</p> |
|
||||
| TLS CA certificate | When **Use separate mTLS cert** is enabled, select and upload the CA certificate for use with mTLS. |
|
||||
| TLS certificate | When **Use separate mTLS cert** is enabled, select and upload the server certificate for use with mTLS. |
|
||||
| TLS CA certificate | When **Use separate mTLS cert** is enabled, select and upload the CA certificate for use with mTLS. When a CA certificate is added, the **Show Certificate** button can be clicked to display the certificate. |
|
||||
| TLS certificate | When **Use separate mTLS cert** is enabled, select and upload the server certificate for use with mTLS. When a TLS certificate is added, the **Show Certificate** button can be clicked to display the certificate. |
|
||||
| TLS key | When **Use separate mTLS cert** is enabled, select and upload the key corresponding to the server certificate. |
|
||||
| Enforce use of Portainer generated Edge ID | Enable this option to require that the Edge ID used by an Edge Agent deployment exist within Portainer's database (in other words, have an environment with the matching ID already created) in order to connect. |
|
||||
|
||||
<figure><img src="../../.gitbook/assets/2.20-settings-edge-edgecompute.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/2.29-admin-settings-edge-settings.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
When you are done, click **Save Settings**.
|
||||
|
||||
|
||||
@@ -18,10 +18,11 @@ There are several types of roles:
|
||||
* **Edge administrator** has full control over all resources in all Edge environments, and access to the Edge Compute features.
|
||||
* **Operator** has operational control over the resources deployed within a given environment. Operator can update, re-deploy, start and stop containers/services, check logs and console into containers, but cannot create or delete any resources.
|
||||
* **Helpdesk** has read-only access to the resources deployed within a given environment but cannot make changes to any resource, nor can they open a console to a container or make changes to a container’s volumes.
|
||||
* **Namespace Operator** has operational control over all existing resources in a namespace of an environment. This is similar to the Operator role, but restricted to specified namespaces instead of the entire environment, and is only available for Kubernetes environments.
|
||||
* **Standard User** has complete control over the resources that a user deploys, or if the user is a member of a team, has complete control over the resources that users of that team deploy.
|
||||
* **Read-Only User** has read-only access to the resources they are entitled to see (resources created by members of their team, and public resources).
|
||||
|
||||
<figure><img src="../../.gitbook/assets/2.20-user-roles-list.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/2.29-admin-user-roles.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
The **Administrator** role sits outside of the other roles and effectively acts as a 'Global Admin'. A user assigned to this role has complete control over Portainer settings, and all resources on every environment under Portainer's control.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Updating on Docker Standalone
|
||||
|
||||
{% hint style="info" %}
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.28.0 make sure all of the agents are also on version 2.28.0.
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.29.2 make sure all of the agents are also on version 2.29.2.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="danger" %}
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
To update the Portainer Edge Agent to the latest version, follow the below instructions for your Edge environment.
|
||||
|
||||
{% hint style="info" %}
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.28.0 make sure all of the agents are also on version 2.28.0.
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.29.2 make sure all of the agents are also on version 2.29.2.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="danger" %}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Updating on Kubernetes
|
||||
|
||||
{% hint style="info" %}
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.28.0 make sure all of the agents are also on version 2.28.0.
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.29.2 make sure all of the agents are also on version 2.29.2.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="warning" %}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Updating on Podman
|
||||
|
||||
{% hint style="info" %}
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.28.0 make sure all of the agents are also on version 2.28.0.
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.29.2 make sure all of the agents are also on version 2.29.2.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="danger" %}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Updating on Docker Swarm
|
||||
|
||||
{% hint style="info" %}
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.28.0 make sure all of the agents are also on version 2.28.0.
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.29.2 make sure all of the agents are also on version 2.29.2.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="warning" %}
|
||||
@@ -28,8 +28,8 @@ Make note of the service names for Portainer. You will need them later.
|
||||
|
||||
```
|
||||
ID NAME MODE REPLICAS IMAGE PORTS
|
||||
tb9gtxc647fw portainer-agent_agent global 3/3 portainer/agent:2.27.2
|
||||
m3a3mtuy55ed portainer_portainer replicated 1/1 portainer/portainer-ee:2.27.2 *:8000->8000/tcp, *:9000->9000/tcp
|
||||
tb9gtxc647fw portainer-agent_agent global 3/3 portainer/agent:2.28.0
|
||||
m3a3mtuy55ed portainer_portainer replicated 1/1 portainer/portainer-ee:2.28.0 *:8000->8000/tcp, *:9000->9000/tcp
|
||||
```
|
||||
|
||||
To update Portainer Server to the most recent version, run one of the sets of commands below depending on your edition of Portainer (replace the `portainer_portainer` service name if your setup differs):
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# Upgrading Agent-only deployments
|
||||
|
||||
Both Portainer Community Edition and Portainer Business Edition use the same Portainer Agent container image to run, so if you are upgrading from CE to BE and have Agent-only environments, you don't need to upgrade them as well - just ensure they are on the same version (for example, if the Portainer Server is version 2.28.0 then the Portainer Agent should be 2.28.0 as well).
|
||||
Both Portainer Community Edition and Portainer Business Edition use the same Portainer Agent container image to run, so if you are upgrading from CE to BE and have Agent-only environments, you don't need to upgrade them as well - just ensure they are on the same version (for example, if the Portainer Server is version 2.29.2 then the Portainer Agent should be 2.29.2 as well).
|
||||
|
||||
@@ -22,10 +22,6 @@ The following sections describe how to manage a Kubernetes environment using men
|
||||
[namespaces](namespaces/)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="helm.md" %}
|
||||
[helm.md](helm.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="applications/" %}
|
||||
[applications](applications/)
|
||||
{% endcontent-ref %}
|
||||
|
||||
@@ -2,18 +2,38 @@
|
||||
|
||||
To view information about Helm applications running in a cluster, from the menu select **Applications** then select the Helm application you want to inspect.
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.20-kubernetes-applications-inspect-helm.gif" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../../.gitbook/assets/2.29-kubernetes-applications-inspect-helm.gif" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
You will be shown details about the Helm application including the name, chart used for the deployment, and the application version.
|
||||
You will be shown details about the Helm application including the name, namespace, revision, chart used for the deployment, the application version, and the chart version. 
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.20-kubernetes-applications-inspect-helm-details.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../../.gitbook/assets/2.29-kubernetes-applications-inspect-helm-details.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
To view information about a specific deployment within a Helm application, from the **Applications** page expand the Helm application by clicking the arrow to the left of the application name then click the name of a deployment within the application.
|
||||
You will also see four tabs that provide additional information about your Helm deployment: [Resources](inspect-helm.md#resources), [Values](inspect-helm.md#values), [Manifest](inspect-helm.md#manifest) and [Notes](inspect-helm.md#notes).
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.20-kubernetes-applications-inspect-helm-deployment.gif" alt=""><figcaption></figcaption></figure>
|
||||
## Resources
|
||||
|
||||
Here you can view full details of the individual deployment within the Helm application.
|
||||
The **Resources** tab displays information about the resources that make up your Helm deployment. The items listed here will vary depending on the contents of your Helm chart. The **Name**, **Resource type**, **Status**, **Status message** and **Actions** are shown for each resource.
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.20-kubernetes-applications-inspect-helm-deployment-details.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../../../.gitbook/assets/2.29-kubernetes-applications-inspect-helm-resources.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
For more detail on the contents of this page, refer to [Inspect an application](inspect.md).
|
||||
Click on the name of select resource types (such as Deployments and Pods) to [view details of that specific resource](inspect.md). Clicking the **Describe** link for a resource will display a raw description of the resource in a popup window.
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.29-kubernetes-applications-inspect-helm-resource-describe.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
## Values
|
||||
|
||||
The **Values** tab shows the raw values set on the deployment. You can check the **User defined only** option to display only those options explicitly specified by the chart, or untick it to show all values including globally set options.
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.29-kubernetes-applications-inspect-helm-values.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
## Manifest
|
||||
|
||||
The **Manifest** tab displays the raw manifest used to deploy the Helm chart.
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.29-kubernetes-applications-inspect-helm-manifest.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
## Notes
|
||||
|
||||
The **Notes** tab displays any notes that were attached to the Helm chart when it was deployed.
|
||||
|
||||
<figure><img src="../../../.gitbook/assets/2.29-kubernetes-applications-inspect-helm-notes.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
# Helm
|
||||
|
||||
In version 2.20 and above we moved Helm support into the [Applications](applications/) section alongside the other application creation and management methods for a more streamlined and user-friendly approach.
|
||||
|
||||
{% content-ref url="applications/" %}
|
||||
[applications](applications/)
|
||||
{% endcontent-ref %}
|
||||
@@ -12,7 +12,7 @@ You can read more about our release principles in our [lifecycle policy](start/l
|
||||
|
||||
### Helm Details  
|
||||
|
||||
2.29 brings a brand new view of Helm deployments to Portainer. Clicking on a Helm deployment within the Applications list takes you to the new Helm details page, which provides a ton of information about the deployment's status and configuration.
|
||||
2.29 brings a brand new view of Helm deployments to Portainer. Clicking on a Helm deployment within the Applications list takes you to the new [Helm details](user/kubernetes/applications/inspect-helm.md) page, which provides a ton of information about the deployment's status and configuration.
|
||||
|
||||
<figure><img src=".gitbook/assets/2.29-whatsnew-helmdetails.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user