diff --git a/content/TruenasApps/StableApps/InstallNetdataApp.md b/content/TruenasApps/StableApps/InstallNetdataApp.md index cf91ba59cf..0a8aca67c6 100644 --- a/content/TruenasApps/StableApps/InstallNetdataApp.md +++ b/content/TruenasApps/StableApps/InstallNetdataApp.md @@ -16,7 +16,7 @@ keywords: --- The TrueNAS Netdata app provides an easy way to install and access the Netdata infrastructure monitoring solution. -TrueNAS deploys the Netdata app in a Kubernetes container using the Helm package manager. +TrueNAS deploys the Netdata app in a Docker container using Docker Compose. After successfully deploying the app, you can access the Netdata web portal from TrueNAS. The Netdata web portal opens on the local dashboard, and where you can create new dashboards, add plugins, metric databases, physical and virtual systems, containers, and other cloud deployments you want to monitor. The portal also provides access to the Netdata Cloud sign-in screen. @@ -24,119 +24,140 @@ The portal also provides access to the Netdata Cloud sign-in screen. {{< include file="/static/includes/AppsUnversioned.md" >}} ## Before You Begin -The TrueNAS Netdata app does not require advance preparation. +Prepare TrueNAS before installing the app by: -You can allow TrueNAS to automatically create storage volumes for the Netdata app or you can create specific datasets to use for configuration, cache, and library storage and extra storage volumes in the container pod. -If using specific datasets, create these before beginning the app installation. +{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginRunAsUser.md" >}} -The administrator account must have sudo permissions enabled. -To verify, go to **Credentials > Local User**. -Click on the administrator user (e.g., admin), then click **Edit**. Scroll down to the sudo permissions. -Select either **Allow all sudo commands** to permit changes after entering a password (not recommended in this instance) or **Allow all sudo commands with not password** to permit changes without requiring a password. -If you upgraded from Angelfish or early releases of Bluefin that do not have an admin user account, see [Creating an Admin User Account]({{< relref "ManageLocalUsersSCALE.md" >}}) for instructions on correctly creating an administrator account with the required permissions. +
{{< trueimage src="/images/SCALE/Apps/NetdataAppDetailsScreen.png" alt="Netdata Information Screen" id="Netdata Information Screen" >}}
-You can create a Netdata account before or after installing and deploying the Netdata app. +{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasets.md" >}} -## Installing Netdata on TrueNAS -To install the **Netdata** application, go to **Apps**, click on **Discover Apps**, then either scroll down to the **Netdata** app widget or begin typing Netdata in the search field to filter the list to find the Netdata app widget. +

Netdata uses three datasets: config, lib, and cache. +Follow the instruction below in **Creating Datasets for Apps** to correctly set up these datasets.

-{{< trueimage src="/images/SCALE/Apps/NetdataWidget.png" alt="Netdata App Widget" id="Netdata App Widget" >}} +
{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md" >}} +
-Click on the widget to open the **Netdata** application details screen. +* (Optional) Create a Netdata account. + The app install wizard allows you to create a new Netdata account when configuring the app in TrueNAS, or to configure it to use a preexisting account. -{{< trueimage src="/images/SCALE/Apps/NetdataAppDetailsScreen.png" alt="Netdata App Details Screen" id="Netdata App Details Screen" >}} +## Installing Netdata in TrueNAS +{{< hint info >}} +This basic procedure covers the required Netdata app settings. +For optional settings, see [Understanding App Installation Wizard Settings](#understanding-app-installation-wizard-settings). +{{< /hint >}} -Click **Install** to open the **Install Netdata** screen. +{{< include file="static/includes/apps/MultipleAppInstancesAndNaming.md" >}} + +{{< include file="/static/includes/apps/LocateAndOpenInstallWizard.md" >}} {{< trueimage src="/images/SCALE/Apps/InstallNetdataScreen.png" alt="Install Netdata Screen" id="Install Netdata Screen" >}} -Application configuration settings presented in several sections, are explained in [Understanding Netdata Settings](#understanding-netdata-wizard-settings) below. -To find specific fields click in the **Search Input Fields** search field, scroll down to a particular section or click on the section heading on the navigation area in the upper-right corner. +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} -Accept the default values in **Application Name** and **Version**. +The TrueNAS app is configured with all the required environment variables, but if you want to further customize the container, click **Add** to the right of **Additional Environment Variables** for each to enter the variable(s) and values(s). +See [Netdata Configuration](#netdata-configuration-settings) below for more information. -Accept the default settings in **Netdata Configuration** and the default port in **Node Port to use for Netdata UI**. +Accept the default values in **Network Configurations**. The TrueNAS Netdata app uses the default port **20489** to communicate with Netdata and show the Netdata local dashboard. +Accept the default settings in **Advanced DNS Settings**. +See [Network Configuration](#network-configuration-settings) below for more information. -Make no changes in the **Storage** section to allow TrueNAS to create the storage volumes for the app, or to use datasets created for Netdata configuration storage, select **Enable Host Path for Netdata** to show the **Host Path for Netdata Configuration** settings. +Add your **Storage Configuration** settings. +Set **Type** for **Netdata Config Storage** to **Host Path (Path that already exists on the system)**. +Select **Enable ACL**, and then enter or browse to and select the **config** dataset to populate the **Host Path** field. -{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png" alt="Install Netdata Storage Enable Host Path" id="Install Netdata Storage Enable Host Path" >}} +{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png" alt="Add Netdata Config Storage ACL and ACE Settings" id="Add Netdata Config Storage ACL and ACE Settings" >}} -Enter or browse to select the dataset created for Netdata configuration storage to populate the mount path. -If using datasets created for cache and library storage, enable these options, then enter or browse to the datasets for each. +Click **Add** to the right of **ACL Entries** to show the block of permissions settings. +Change **ID Type** to user, enter **0** in **ID**, and set **Access** to full control. -Accept the default settings in **Advanced DNS Settings**. +Next, select **Force Flag**. + +Repeat the above for the **lib** and **cache** storage volumes. -Accept the default values in **Resources Limits** or select **Enable Pod Resource limits** to show resource configuration options for CPU and memory and enter new values to suit your use case. +Accept the defaults in **Resources Configuration**. -Click **Install**. +Click **Install**. A progress dialog displays before switching to the **Installed** applications screen. The system opens the **Installed Applications** screen with the Netdata app in the **Deploying** state. When the installation completes it changes to **Running**. {{< trueimage src="/images/SCALE/Apps/NetdataInstalled.png" alt="Netdata Installed" id="Netdata Installed" >}} +{{< trueimage src="/images/SCALE/Apps/NetdataSignInScreen.png" alt="Nextcloud Sign In Screen" id="Nextcloud Sign In Screen" >}} + Click **Web Portal** on the **Application Info** widget to open the Netdata web interface showing the local dashboard. {{< trueimage src="/images/SCALE/Apps/NetdataWebPortalLocalDashboard.png" alt="Netdata Web Portal Local Dashboard" id="Netdata Web Portal Local Dashboard" >}} -## Understanding Netdata Wizard Settings -The following sections provide more detail explanations of the settings found in each section of the **Install Netdata** screen. +Refer to Netdata user guides and documentation for more information on configuring Netdata dashboards. + +## Understanding App Installation Wizard Settings + +The following section provides more detailed explanations of the settings in each section of the **Install Netdata** wizard. ### Application Name Settings -{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### Netdata Configuration Settings -You can accept the defaults in the **Netdata Configuration** settings or enter the settings you want to use. - -Click **Add** to the right of **Netdata image environment** to display the environment variable **Name** and **Value** fields. +Accept defaults in the **Netdata Configuration** settings, or to customize the container deployment click **Add** to the right of **Additional Environment Variables** to show the **Name** and **Value** fields used to enter variables. Netdata does not require using environment variables to deploy the application but you can enter any you want to use to customize your container. {{< trueimage src="/images/SCALE/Apps/InstallNetdataConfigAddEnvironmentVariable.png" alt="Netdata Configuration Add Environment Variable" id="Netdata Configuration Add Environment Variable" >}} +Refer to Netdata user guides and documentation for information on configuring and customizing your app. +Guides include [GitHub Install Netdata with Docker](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md), and [Netdaa Deployment Guides](https://learn.netdata.cloud/docs/deployment-guides/). +Netdata provides assistance through their community forums and [Support site](https://www.netdata.cloud/support/). + +### Network Configuration Settings The TrueNAS Netdata app uses port **20489** to communicate with Netdata and open the web portal. Netdata documentation states it uses **19999** as the default port, but it recommends restricting access to this for security reasons. -Refer to the TrueNAS [default port list](https://www.truenas.com/docs/references/defaultports/) for a list of assigned port numbers. -To change the port numbers, enter a number within the range 9000-65535. -### Netdata Storage Settings -TrueNAS defaults to automatically creating storage volumes for Netdata without enabling the host path options. +{{< include file="/static/includes/apps/InstallWizardDefaultPorts.md" >}} +{{< include file="static/includes/apps/InstallWizardHostNetworkSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardAdvancedDNSSettings.md" >}} + +### Storage Configuration Settings +TrueNAS provides two options for storage volumes: ixVolumes and host paths. -To create and use datasets for the Netdata configuration, cache, and library storage or extra storage volumes inside the container pod, first create these datasets. -Go to **Datasets** and create the datasets before you begin the app installation process. -See [Add Datasets]({{< relref "DatasetsScale.md" >}}) for more information. -Select **Enable Host Path for Netdata** to show the volume mount path field to add the configuration storage dataset. +Netdata needs three datasets: +* **config** +* **lib** +* **cache** -{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png" alt="Install Netdata Storage Enable Host Path" id="Install Netdata Storage Enable Host Path" >}} +Create datasets before beginning the app installation process. Set the **Dataset Preset** to **Apps** before saving the datasets. +If you group the required datasets under a parent dataset, for example, a dataset named *netdata*, set the **Dataset Preset** to **Apps** to avoid permissions error messages and issues that can block fully deploying the app. See [Before You Begin](#before-you-begin) for more information on adding these datasets. -Enter or browse to select the dataset and populate the mount path field. -To use datasets created for cache and library storage volumes, first enable each option and then enter or browse to select the datasets tp populate the mount path fields for each. +You can add extra storage volumes at the time of installation or edit the application after it deploys. Stop the app before editing settings. +{{< include file="/static/includes/apps/InstallAppStorageConfig2.md" >}} -If you want to add storage volumes inside the container pod for other storage, click **Add** to the right of **Extra Host Path Volumes** for each storage volume (dataset) you want to add. +#### Setting Dataset ACL Permissions +You can configure ACL permissions for the required dataset in the **Install Netdata** wizard, or from the **Datasets** screen any time after adding the datasets. -{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageExtraHostPath.png" alt="Install Netdata Storage Add Extra Host Path" id="Install Netdata Storage Add Extra Host Path" >}} +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} -You can add extra storage volumes at the time of installation or edit the application after it deploys. Stop the app before editing settings. +{{< expand "Adding ACL Permissions from the Datasets Screen" "v">}} +First select the dataset row, and scroll down to the **Permissions** widget, and then click **Edit** to open the **Edit ACL** screen. +Change the **@owner** and **@group** values from **root** to the administrative user for your TrueNAS system, and click apply for each. +Next, add an ACL entry for the run-as user. +For Netdata, the run-as users is **0** for **root**. Add a user entry for this user. +Save the ACL before leaving the screen. -### Advanced DNS Settings -The default **DNS Configuration** is sufficient for a basic installation. -To specify additional DNS options, click **Add** to the right of **DNS Options** to add the DNS **Option Name** and **Option Value** fields. +See [Setting Up Permissions]({{< relref "PermissionsSCALE.md" >}}) and [Edit ACL Screen]({{< relref "EditACLScreens.md" >}}) for more information. +{{< /expand >}} -{{< trueimage src="/images/SCALE/Apps/InstallNetdataAdvancedDNSOptions.png" alt="Install Netdata Advanced DNS Options" id="Install Netdata Advanced DNS Options" >}} +#### Mounting an SMB Share Storage Volume +TrueNAS **Additional Storage** options include the ability to mount an SMB share inside the container pod. -### Resource Limits Settings -Accept the default values in **Resources Limits** or select **Enable Pod Resource limits** to show CPU and memory resource configuration options. +{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}} -By default, the application is limited to use no more than four CPU cores and eight gigabytes available memory. -The application might use considerably less system resources. +### Resources Configuration Settings {{< trueimage src="/images/SCALE/Apps/InstallNetdataResourceLimitsEnablePod.png" alt="Install Netdata Resource Limits" id="Install Netdata Resource Limits" >}} -To customize the CPU and memory allocated to the container (pod) Netdata uses, enter new CPU values as a plain integer value followed by the suffix m (milli). -Default is 4000m. - -Accept the default value 8Gi allocated memory or enter a new limit in bytes. -Enter a plain integer followed by the measurement suffix, for example 129M or 123Mi. +{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}} ## Using the Netdata Web Portal After deploying the TrueNAS Netdata app click on **Web Portal** to open the Netdata agent local dashboard. diff --git a/static/images/SCALE/Apps/InstallNetdataScreen.png b/static/images/SCALE/Apps/InstallNetdataScreen.png index b1fc5aaa3d..77233059ff 100644 Binary files a/static/images/SCALE/Apps/InstallNetdataScreen.png and b/static/images/SCALE/Apps/InstallNetdataScreen.png differ diff --git a/static/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png b/static/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png new file mode 100644 index 0000000000..e5848243ca Binary files /dev/null and b/static/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png differ diff --git a/static/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png b/static/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png deleted file mode 100644 index 3a1bd61209..0000000000 Binary files a/static/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png and /dev/null differ diff --git a/static/images/SCALE/Apps/NetdataAppDetailsScreen.png b/static/images/SCALE/Apps/NetdataAppDetailsScreen.png index 37ef2d5d2b..acf63a6794 100644 Binary files a/static/images/SCALE/Apps/NetdataAppDetailsScreen.png and b/static/images/SCALE/Apps/NetdataAppDetailsScreen.png differ diff --git a/static/images/SCALE/Apps/NetdataSignInScreen.png b/static/images/SCALE/Apps/NetdataSignInScreen.png index 67ddb5a317..51d191737f 100644 Binary files a/static/images/SCALE/Apps/NetdataSignInScreen.png and b/static/images/SCALE/Apps/NetdataSignInScreen.png differ diff --git a/static/includes/apps/BeforeYouBeginAddAppDatasets.md b/static/includes/apps/BeforeYouBeginAddAppDatasets.md index 858e2cde24..fe88093c94 100644 --- a/static/includes/apps/BeforeYouBeginAddAppDatasets.md +++ b/static/includes/apps/BeforeYouBeginAddAppDatasets.md @@ -1,6 +1,13 @@ * Create datasets for the storage volumes for the app. + + {{< hint type=warning title="Encrypted Datasets" >}} + Do not create encrypted datasets for apps if not required! + Using an encrypted dataset can result in undesired behaviors after upgrading TrueNAS when pools and datasets are locked. + When datasets for the containers are locked, the container does not mount, and the apps do not start. + To resolve issues, unlock the dataset(s) by entering the passphrase/key to allow datasets to mount and apps to start. + {{< /hint >}} Go to **Datasets** and select the pool or dataset where you want to place the dataset(s) for the app. For example, */tank/apps/appName*. \ No newline at end of file diff --git a/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md b/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md new file mode 100644 index 0000000000..a7a0fb44d1 --- /dev/null +++ b/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md @@ -0,0 +1,25 @@ + + + {{< expand "Creating Datasets for Apps" "v" >}} + When creating datasets for apps follow these steps: + 1. Go to **Datasets**, select the location for the parent dataset if organizing required datasets under a parent dataset, then click **Add Dataset**. + For example, select the root dataset of the pool, and click **Add Dataset** to create a new parent called *apps* or *appName**, where *appName* is the name of the app. + + Do not create the app datasets under the ix-applications or ix-apps dataset. + + 2. Enter the name of the dataset, then select **Apps** as the **Dataset Preset**. + Creating the parent dataset with the preset set to **Generic** causes permissions issues when you try to create the datasets the app requires with the preset set to **Apps**. + + 3. Click **Save**. + Return to dataset creation when prompted rather than configuring ACL permissions. + + You can set up permissions (ACLs) for a dataset after adding it by selecting **Go to ACL Manager** to open the Edit ACL screen, or wait and use the app Install wizard ACL settings to add permissions. + You can also edit permissions after installing the app using either method. + + 4. Select the parent dataset and then click **Create Dataset** to open the **Add Dataset** screen again. + + 5. Enter the name of a dataset required for the app, such as *config*, select **Apps** as the **Dataset Preset**, and then click **Save**. + When prompted, return to creating datasets rather than setting up ACL permissions. + + 6. Repeat for remaining datasets required for the app. + {{< /expand >}} \ No newline at end of file diff --git a/static/includes/apps/BeforeYouBeginRunAsUser.md b/static/includes/apps/BeforeYouBeginRunAsUser.md index 9ccf4e30de..5f404a3515 100644 --- a/static/includes/apps/BeforeYouBeginRunAsUser.md +++ b/static/includes/apps/BeforeYouBeginRunAsUser.md @@ -3,5 +3,4 @@ * Locate the run-as user for the app. Take note of the run-as user for the app, shown on the app information screen in the **Run As Content** widget and in the **Application Metadata** widget on the **Installed** applications screen after the app fully deploys. - The run-as user(s) get added to the ACL permissions for each dataset used as a host path storage volume. - + The run-as user(s) get added to the ACL permissions for each dataset used as a host path storage volume. \ No newline at end of file diff --git a/static/includes/apps/BeforeYouBeginStableApps.md b/static/includes/apps/BeforeYouBeginStableApps.md index 14f5e7cc9e..6a016d8adf 100644 --- a/static/includes/apps/BeforeYouBeginStableApps.md +++ b/static/includes/apps/BeforeYouBeginStableApps.md @@ -2,17 +2,10 @@ * Set a pool for applications to use if not already assigned. - {{< hint type=warning title="Encrypted Pools" >}} - Do not select an encrypted pool as the app pool! - Selecting an encrypted pool can cause app issues after upgrading the system when pools and any datasets in the pool are locked. - If using the encrypted root dataset of the pool, the dataset for the containers does not mount, and the containers do not start. - To resolve issues, unlock the dataset(s) by entering the passphrase/key to allow all nested datasets to mount and start. - {{< /hint >}} - You can use either an existing pool or [create a new one]({{< relref "CreatePoolWizard.md" >}}). - Go to **Apps**. If the pool for apps is not already set, do it when prompted. TrueNAS creates the **ix-apps** (hidden) dataset in the pool set as the application pool. This dataset is internally managed, so you cannot use this as the parent when you create required application datasets. - After setting the pool, the **Installed Applications** screen displays **Apps Service Running** on the top screen banner. {{< trueimage src="/images/SCALE/Apps/AppsChooseAPoolForApps.png" alt="Choose A Pool for Apps" id="Choose A Pool for Apps" >}} + + After setting the pool, the **Installed Applications** screen displays **Apps Service Running** on the top screen banner.