Docs: Refactor administration docs (#50592)
* Move data source management to administration * Move RBAC to administration * Move team management up a docs org level * Combine and rename admin preferences docs * Move plugin management to administration * Combine plugin management docs * Combine API key docs * Combine service account docs * Combine server user management docs * Move datasource management to administration * Move enterprise licenses to administration * Move CLI out of admin, update links to admin * Merge org user management docs * Restructure to Torkel's plan * Fix typo * Weigh admin topics for navigation * Weigh administration topics and align to Torkel's plan * Move server user management from server admin to admin/user management * Move configure docker image to setup guide * Move the remaining server admin docs to the root admin directory * Reweight docker config
This commit is contained in:
Garrett Guillotte
@@ -0,0 +1,245 @@
|
||||
---
|
||||
aliases:
|
||||
- /docs/grafana/latest/enterprise/license/
|
||||
- /docs/grafana/latest/enterprise/activate-license/
|
||||
- /docs/grafana/latest/enterprise/license/activate-license/
|
||||
- /docs/grafana/latest/enterprise/license-expiration/
|
||||
- /docs/grafana/latest/enterprise/license/license-expiration/
|
||||
- /docs/grafana/latest/enterprise/license-restrictions/
|
||||
- /docs/grafana/latest/enterprise/license/license-restrictions/
|
||||
description: Activate and manage a Grafana Enterprise license
|
||||
keywords:
|
||||
- grafana
|
||||
- licensing
|
||||
- enterprise
|
||||
title: Enterprise licensing
|
||||
weight: 500
|
||||
---
|
||||
|
||||
# Grafana Enterprise license
|
||||
|
||||
When you become a Grafana Enterprise customer, you gain access to Grafana's premium observability features, including enterprise data source plugins, reporting, and role-based access control. In order to use these [enhanced features of Grafana Enterprise]({{< relref "../enterprise/" >}}), you must purchase and activate a Grafana Enterprise license.
|
||||
|
||||
To purchase a license directly from Grafana Labs, [Contact a Grafana Labs representative](https://grafana.com/contact?about=grafana-enterprise). To activate an Enterprise license purchased from Grafana Labs, refer to [Activate an Enterprise license]({{< relref "../server-administration/enterprise-licensing/activate-license/" >}}).
|
||||
|
||||
You can also purchase a Grafana Enterprise license through the AWS Marketplace. To learn more about activating a license purchased through AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "activate-aws-marketplace-license/" >}}).
|
||||
|
||||
{{< section >}}
|
||||
|
||||
## Activate an Enterprise license
|
||||
|
||||
Follow these steps to activate your Grafana Enterprise license:
|
||||
|
||||
### Step 1. Download your license file
|
||||
|
||||
To download your Grafana Enterprise license:
|
||||
|
||||
1. Sign in to your [Grafana Cloud](https://grafana.com) account.
|
||||
1. Go to **My Account** and select an organization from the drop-down menu at the top left of the page. On the Overview page for each organization, you can see a section for Grafana Enterprise licenses. Click **Details** next to a license.
|
||||
1. At the bottom of the license details page, select **Download token** to download the `license.jwt` file that contains your license.
|
||||
|
||||
### Step 2. Add your license to a Grafana instance
|
||||
|
||||
There is more than one way to add the license to a Grafana instance:
|
||||
|
||||
#### Upload the license file via the Grafana server administrator page
|
||||
|
||||
This is the preferred option for single instance installations of Grafana Enterprise.
|
||||
|
||||
1. Sign in as a Grafana server administrator.
|
||||
1. Navigate to **Server Admin > Upgrade** within Grafana.
|
||||
1. Click **Upload license token file**.
|
||||
1. Select your license file, and upload it.
|
||||
|
||||
#### Put the `license.jwt` file into the data directory of Grafana
|
||||
|
||||
On Linux systems, the data directory is usually at `/var/lib/grafana`.
|
||||
|
||||
You can also configure a custom location for the license file using the grafana.ini setting:
|
||||
|
||||
```bash
|
||||
[enterprise]
|
||||
license_path = /company/secrets/license.jwt
|
||||
```
|
||||
|
||||
This setting can also be set with an environment variable, which is useful if you're running Grafana with Docker and have a custom volume where you have placed the license file. In this case, set the environment variable `GF_ENTERPRISE_LICENSE_PATH` to point to the location of your license file.
|
||||
|
||||
#### Set the content of the license file as a configuration option
|
||||
|
||||
You can add a license by pasting the content of the `license.jwt`
|
||||
to the grafana.ini configuration file:
|
||||
|
||||
```bash
|
||||
[enterprise]
|
||||
license_text = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0aGlzIjoiaXMiLCJub3QiOiJhIiwidmFsaWQiOiJsaWNlbnNlIn0.bxDzxIoJlYMwiEYKYT_l2s42z0Y30tY-6KKoyz9RuLE
|
||||
```
|
||||
|
||||
This option can be set using the `GF_ENTERPRISE_LICENSE_TEXT`
|
||||
environment variable.
|
||||
|
||||
### Step 3. Ensure that the license file's root URL matches the root_url configuration option
|
||||
|
||||
Update the [`root_url`]({{< relref "../../enterprise/setup-grafana/configure-grafana/#root-url" >}}) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s).
|
||||
|
||||
This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [`root_url`]({{< relref "../../enterprise/setup-grafana/configure-grafana/#root-url" >}}) in your configuration.
|
||||
|
||||
In your configuration file:
|
||||
|
||||
```
|
||||
[server]
|
||||
root_url = https://grafana.example.com/
|
||||
```
|
||||
|
||||
Or with an environment variable:
|
||||
|
||||
```
|
||||
GF_SERVER_ROOT_URL=https://grafana.example.com/
|
||||
```
|
||||
|
||||
### Step 4. Restart Grafana
|
||||
|
||||
To finalize the installation of Grafana Enterprise, restart Grafana to enable all Grafana Enterprise features. Refer to [restart Grafana]({{< relref "../../enterprise/setup-grafana/restart-grafana/" >}}) for more information.
|
||||
|
||||
## License expiration
|
||||
|
||||
If your license has expired, most of Grafana keeps working as normal. Some enterprise functionality stops or runs with reduced functionality and Grafana displays a banner informing the users that Grafana is running on an expired license. Your Grafana admin needs to upload a new license file to restore full functionality.
|
||||
|
||||
> Replace your license as soon as possible. Running Grafana Enterprise with an expired license is unsupported and can lead to unexpected consequences.
|
||||
|
||||
### Update your license
|
||||
|
||||
1. Locate your current `license.jwt` file. In a standard installation it is stored inside the Grafana data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration]({{< relref "../../enterprise/setup-grafana/configure-grafana/" >}}).
|
||||
|
||||
```ini
|
||||
[enterprise]
|
||||
license_path = /path/to/your/license.jwt
|
||||
```
|
||||
|
||||
The configuration file's location may also be overridden by the `GF_ENTERPRISE_LICENSE_PATH` environment variable.
|
||||
|
||||
2. Log in to your [Grafana Cloud Account](https://grafana.com/login) and make sure you're in the correct organization in the dropdown at the top of the page.
|
||||
3. Under the **Grafana Enterprise** section in the menu bar to the left, choose licenses and download the currently valid license with which you want to run Grafana. If you cannot see a valid license on Grafana.com, please contact your account manager at Grafana Labs to renew your subscription.
|
||||
4. Replace the current `license.jwt`-file with the one you've just downloaded.
|
||||
5. [Restart Grafana]({{< relref "../../enterprise/setup-grafana/restart-grafana/" >}}).
|
||||
|
||||
### If your license expires
|
||||
|
||||
If your Grafana Enterprise license expires, you can expect the following changes in feature behavior.
|
||||
|
||||
#### Data source permissions
|
||||
|
||||
Your current data source permissions will keep working as expected, but you'll be unable to add new data source permissions until the license has been renewed.
|
||||
|
||||
#### LDAP authentication
|
||||
|
||||
- LDAP synchronization is not affected by an expired license.
|
||||
- Team sync debugging is unavailable.
|
||||
|
||||
#### SAML authentication
|
||||
|
||||
SAML authentication is not affected by an expired license.
|
||||
|
||||
#### Role-based access control (RBAC)
|
||||
|
||||
- Creating, updating and deleting custom roles is not available.
|
||||
- Modifying permissions for custom roles is not available.
|
||||
|
||||
#### Reporting
|
||||
|
||||
- You're unable to configure new reports or generate previews.
|
||||
- Existing reports continue to be sent.
|
||||
|
||||
#### Enterprise plugins
|
||||
|
||||
Enterprise plugins might stop working.
|
||||
|
||||
#### White labeling
|
||||
|
||||
The white labeling feature is turned off, meaning that any white labeling options will not have any effect.
|
||||
|
||||
#### Usage insights
|
||||
|
||||
Exporting usage insights logs to Loki will be turned off for licenses expired for more than 7 days.
|
||||
|
||||
All the other usage insights features are turned off as soon as the license expires, meaning that you will not be able to see dashboard usage, presence indicators, or use improved search. Grafana continues to collect usage data and you will have access to it as soon as you update your license.
|
||||
|
||||
#### Vault integration
|
||||
|
||||
Vault integration is not affected by an expired license.
|
||||
|
||||
#### Auditing
|
||||
|
||||
Auditing is not affected by an expired license.
|
||||
|
||||
#### License restrictions
|
||||
|
||||
The concurrent session limit remains active for seven days after the expiration date, after which it will be turned off.
|
||||
|
||||
The active users limit is turned off immediately.
|
||||
|
||||
#### Settings updates at runtime
|
||||
|
||||
Settings updates at runtime are not affected by an expired license.
|
||||
|
||||
## Grafana Enterprise license restrictions
|
||||
|
||||
When you become a Grafana Enterprise customer, you receive a license that governs your use of Grafana Enterprise.
|
||||
|
||||
### Active users limit
|
||||
|
||||
Your Grafana license includes a maximum number of active users.
|
||||
|
||||
- An _active user_ is a user who has signed in to Grafana within the last 30 days. This is a rolling window that is updated daily.
|
||||
- When you reach the maximum number of active users, only currently active users (users who have signed in over the past 30 days) can sign in. When a new user or a previously-inactive user tries to sign in, the user will see an error message indicating that Grafana has reached its license limit.
|
||||
- The user's role, number of dashboards that a user can view or edit, and the number of organizations that they can access does not affect the active user count.
|
||||
- A license limit banner appears to administrators when Grafana reaches its active user limit; editors and viewers do not see the banner.
|
||||
|
||||
#### Determine the number of active users
|
||||
|
||||
To determine the number of active users:
|
||||
|
||||
1. Sign in to Grafana Enterprise as a System Administrator.
|
||||
|
||||
1. Click **Server Admin** (the shield icon).
|
||||
|
||||
1. Click **Statistics and licensing**.
|
||||
|
||||
1. Review the utilization count on the **Utilization** panel.
|
||||
|
||||
### Tiered licensing (deprecated)
|
||||
|
||||
A tiered license defines dashboard viewers, and dashboard editors and administrators, as two distinct user types that each have their own user limit.
|
||||
|
||||
As of Grafana Enterprise version 9.0, Grafana only counts and enforces the _total_ number of active users in your Grafana instance. For example, if you purchase 150 active users, you can have 20 admins, 70 editors, and 60 viewers, or you can have 150 admins. Grafana will enforce the total number of active users even if you use a license that grants a specific number of admins or editors and a certain number of viewers. This is a more permissive policy than before, which gives you the flexibility to change users' roles.
|
||||
|
||||
If you are running a pre-9.0 version of Grafana Enterprise, please refer to the documentation for that version to learn more about license enforcement in your current version.
|
||||
|
||||
### Additional license restrictions
|
||||
|
||||
Your license is controlled by the following rules:
|
||||
|
||||
**License expiration date:** The license includes an expiration date, which is the date when a license becomes inactive.
|
||||
|
||||
As the license expiration date approaches, you will see a banner in Grafana that encourages you to renew. To learn about how to renew your license and what happens in Grafana when a license expires, refer to [License expiration]({{< relref "../../enterprise/license/license-restrictions/license-expiration/" >}}).
|
||||
|
||||
**Grafana License URL:** Your license does not work with an instance of Grafana with a different root URL.
|
||||
|
||||
The License URL is the complete URL of your Grafana instance, for example `https://grafana.your-company.com/`. It is defined in the [root_url]({{< relref "../../enterprise/setup-grafana/configure-grafana/#root_url" >}}) configuration setting.
|
||||
|
||||
**Concurrent sessions limit**: As of Grafana Enterprise 7.5, users can initiate up to three concurrent sessions of Grafana.
|
||||
|
||||
The system creates a session when a user signs in to Grafana from a new device, a different browser, or an incognito window. If a user signs in to Grafana from another tab or window within the same browser, only one session is used.
|
||||
|
||||
When a user reaches the session limit, the fourth connection succeeds and the longest inactive session is signed out.
|
||||
|
||||
### Request usage billing
|
||||
|
||||
You can request Grafana Labs to activate usage billing which allows an unlimited number of active users. When usage billing is enabled, Grafana does not enforce active user limits or display warning banners. Instead, you are charged for active users that exceed the limit, according to your customer contract.
|
||||
|
||||
Usage billing involves a contractual agreement between you and Grafana Labs, and it is only available if Grafana Enterprise is configured to [automatically refresh its license token]({{< relref "../../enterprise/setup-grafana/configure-grafana/enterprise-configuration/#auto_refresh_license" >}}).
|
||||
|
||||
### Request a change to your license
|
||||
|
||||
To increase the number of licensed users within Grafana, extend a license, or change your licensed URL, contact [Grafana support](https://grafana.com/profile/org#support) or your Grafana Labs account team. They will update your license, which you can activate from within Grafana.
|
||||
|
||||
For instructions about how to activate your license after it is updated, refer to [Activate an Enterprise license]({{< relref "../../enterprise/license/license-restrictions/activate-license/" >}}).
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
---
|
||||
aliases:
|
||||
- /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/
|
||||
description: Activate Enterprise license purchased through AWS Marketplace
|
||||
- /docs/grafana/latest/enterprise/activate-aws-marketplace-license/about-ge-license-through-aws/
|
||||
- /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/about-ge-license-through-aws/
|
||||
keywords:
|
||||
- grafana
|
||||
- aws
|
||||
- marketplace
|
||||
- enterprise
|
||||
- license
|
||||
title: Enterprise licenses through AWS Marketplace
|
||||
weight: 400
|
||||
---
|
||||
|
||||
# Activate a Grafana Enterprise license purchased through AWS Marketplace
|
||||
|
||||
AWS Marketplace is a convenient place for AWS customers to buy and manage a license for Grafana Enterprise versions 8.3.0 and later.
|
||||
|
||||
{{< section >}}
|
||||
|
||||
You can deploy Grafana Enterprise in the following ways:
|
||||
|
||||
- Using AWS services like ECS, EKS or EC2.
|
||||
- In an instance outside AWS.
|
||||
|
||||
In each case, you must activate the Grafana Enterprise license purchased in AWS Marketplace to take advantage of Grafana Enterprise observability features. Grafana Enterprise licenses purchased through AWS Marketplace are subject to the same [restrictions]({{< relref "../../../../enterprise/license/activate-aws-marketplace-license/license-restrictions/" >}}) as Grafana Enterprise licensed purchased directly from Grafana Labs.
|
||||
|
||||
> To purchase a license directly from Grafana Labs or learn more about other Grafana offerings, [Contact a Grafana Labs representative](https://grafana.com/contact?about=grafana-enterprise).
|
||||
|
||||
## Before you begin
|
||||
|
||||
Become an AWS customer. Only AWS customers have access to purchase services through AWS Marketplace. To learn more about becoming an AWS customer, refer to [Sign up for AWS](https://portal.aws.amazon.com/billing/signup#/start).
|
||||
+113
@@ -0,0 +1,113 @@
|
||||
---
|
||||
aliases:
|
||||
- /docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-ecs/
|
||||
- /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-ecs/
|
||||
description: Activate a Grafana Enterprise license from AWS Marketplace on ECS
|
||||
keywords:
|
||||
- grafana
|
||||
- ecs
|
||||
- enterprise
|
||||
- aws
|
||||
- marketplace
|
||||
- activate
|
||||
title: Activate a Grafana Enterprise license from AWS Marketplace on ECS
|
||||
weight: 250
|
||||
---
|
||||
|
||||
# Activate a Grafana Enterprise license from AWS Marketplace on ECS
|
||||
|
||||
If you have purchased a Grafana Enterprise subscription through AWS Marketplace, you must activate it in order to use Grafana Enterprise data source plugins and features in Grafana.
|
||||
|
||||
## Before you begin
|
||||
|
||||
- Purchase a subscription to [Grafana Enterprise from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-dlncd4kzt5kx6).
|
||||
- Be sure that the IAM user that was used to purchase Grafana Enterprise has permission to manage subscriptions, create new IAM users and roles, and create access policies.
|
||||
|
||||
To activate your license, complete the following tasks.
|
||||
|
||||
## Task 1: Deploy Grafana Enterprise on Amazon ECS
|
||||
|
||||
1. Deploy Grafana Enterprise on Amazon ECS.
|
||||
|
||||
For more information about deploying an application on Amazon ECS, refer to [Creating an Amazon ECS service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service.html).
|
||||
|
||||
1. As you create the Amazon ECS service, use the Grafana Enterprise version 8.3.0 or later container image.
|
||||
|
||||
For example, enter `grafana/grafana-enterprise:8.3.3`.
|
||||
|
||||
> Only Grafana Enterprise versions 8.3.0 and later support licenses granted through AWS Marketplace.
|
||||
|
||||
## Task 2: Configure Grafana for high availability
|
||||
|
||||
Grafana requires that you configure a database to hold dashboards, users, and other persistent data.
|
||||
|
||||
### Before you begin
|
||||
|
||||
- Ensure that you have a supported Grafana database available.
|
||||
- For a list of supported databases, refer to [Supported databases]({{< relref "../../../../enterprise/setup-grafana/installation/#supported-databases" >}}).
|
||||
- For information about creating a database, refer to [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html).
|
||||
- Review the information required to connect to the RDS DB instance. For more information, refer to [Connecting to an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_CommonTasks.Connect.html).
|
||||
|
||||
To configure Grafana for high availability:
|
||||
|
||||
1. In AWS ECS, use environment variables to update the `database` parameters.
|
||||
|
||||
For a list of database parameters, refer to [Configuration]({{< relref "../../../../enterprise/setup-grafana/configure-grafana/#database" >}}).
|
||||
|
||||
1. Create a revision of the task definition for the ECS Task that runs Grafana Enterprise.
|
||||
|
||||
For more information about creating a task, refer to [Updating a task definition using the classic console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-task-definition.html).
|
||||
|
||||
1. Within the new revision, edit the Grafana Enterprise container for this task, and add the following environment variables to the container:
|
||||
|
||||
```
|
||||
GF_DATABASE_TYPE=[database type]
|
||||
GF_DATABASE_HOST=[database address and port]
|
||||
GF_DATABASE_NAME=[database name]
|
||||
GF_DATABASE_USER=[database username]
|
||||
GF_DATABASE_PASSWORD=[database password]
|
||||
```
|
||||
|
||||
> For more information about how to update your ECS service with an environment variable, refer to [Updating a service using the new console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html).
|
||||
|
||||
## Task 3: Configure Grafana Enterprise to validate its license with AWS
|
||||
|
||||
In this task you configure Grafana Enterprise to validate the license with AWS instead of Grafana Labs.
|
||||
|
||||
1. In AWS IAM, create an access policy with the following permissions:
|
||||
|
||||
- `"license-manager:CheckoutLicense"`
|
||||
- `"license-manager:ListReceivedLicenses"`
|
||||
- `"license-manager:GetLicenseUsage"`
|
||||
- `"license-manager:CheckInLicense"`
|
||||
|
||||
For more information about creating an access policy, refer to [Creating IAM policies (console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create-console.html).
|
||||
|
||||
For more information about AWS license permissions, refer to [Actions, resources, and condition keys for AWS License Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awslicensemanager.html).
|
||||
|
||||
1. Create an Elastic Container Service task role and attach the policy you created in the previous step.
|
||||
|
||||
For more information about creating a task role, refer to [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html).
|
||||
|
||||
1. Create a revision of the task definition for the ECS Task that runs Grafana Enterprise.
|
||||
|
||||
For more information about creating a revision of the task definition, refer to [Updating a task definition using the classic console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-task-definition.html).
|
||||
|
||||
1. Within the new revision, perform the following steps:
|
||||
|
||||
a. Update the Task Role of your ECS Task to the role that you created, with permission to access license information.
|
||||
|
||||
b. Edit the Grafana Enterprise container for this task, and add the following environment variable to the container:
|
||||
|
||||
```
|
||||
GF_ENTERPRISE_LICENSE_VALIDATION_TYPE=aws
|
||||
```
|
||||
|
||||
For more information about how to update your ECS service with an environment variable, refer to [Updating a service using the new console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html).
|
||||
|
||||
### Task 4: Start or restart Grafana
|
||||
|
||||
1. To restart Grafana and activate your license, update the service running Grafana to use the latest revision of the task definition that you created.
|
||||
1. After you update the service, navigate to your Grafana instance, sign in with Grafana Admin credentials, and navigate to the **Statistics and Licensing** page to validate that your license is active.
|
||||
|
||||
For more information about validating that your license is active, refer to [Determine the number of active users for each licensed role](../../license-restrictions/#determine-the-number-of-active-users-for-each-licensed-role).
|
||||
+126
@@ -0,0 +1,126 @@
|
||||
---
|
||||
aliases:
|
||||
- /docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-eks/
|
||||
- /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-eks/
|
||||
description: Activate a Grafana Enterprise license from AWS Marketplace on EKS
|
||||
keywords:
|
||||
- grafana
|
||||
- enterprise
|
||||
- aws
|
||||
- marketplace
|
||||
- eks
|
||||
- activate
|
||||
title: Activate a Grafana Enterprise license from AWS Marketplace on EKS
|
||||
weight: 200
|
||||
---
|
||||
|
||||
# Activate a Grafana Enterprise license from AWS Marketplace on EKS
|
||||
|
||||
If you have purchased a Grafana Enterprise subscription through AWS Marketplace, you must activate it in order to use Grafana Enterprise data source plugins and features in Grafana.
|
||||
|
||||
## Before you begin:
|
||||
|
||||
- Purchase a subscription to [Grafana Enterprise from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-dlncd4kzt5kx6).
|
||||
- Be sure that the IAM user that was used to purchase Grafana Enterprise has permission to manage subscriptions, create new IAM users and roles, and create access policies.
|
||||
|
||||
To activate your license, complete the following tasks:
|
||||
|
||||
## Task 1: Deploy Grafana Enterprise on Amazon EKS
|
||||
|
||||
1. Deploy Grafana Enterprise on Amazon EKS.
|
||||
|
||||
For more information about deploying an application on Amazon EKS, refer to [Getting started with Amazon EKS – AWS Management Console and AWS CLI](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-console.html).
|
||||
|
||||
For more information about installing Grafana on Kubernetes using the Helm Chart, refer to the [Grafana Helm Chart](https://github.com/grafana/helm-charts/tree/main/charts/grafana#readme).
|
||||
|
||||
1. Use `kubectl set image deployment/my-release grafana=grafana/grafana-enterprise:<version>` to update the container image to Grafana Enterprise version 8.3.0 or later.
|
||||
|
||||
For example, enter `grafana/grafana-enterprise:8.3.3`.
|
||||
|
||||
> Only Grafana Enterprise versions 8.3.0 and later support licenses granted through AWS Marketplace.
|
||||
|
||||
## Task 2: Configure Grafana for high availability
|
||||
|
||||
Grafana requires that you configure a database to hold dashboards, users, and other persistent data.
|
||||
|
||||
### Before you begin
|
||||
|
||||
- Ensure that you have a supported Grafana database available.
|
||||
- For a list of supported databases, refer to [Supported databases]({{< relref "../../../../setup-grafana/installation/#supported-databases" >}}).
|
||||
- For information about creating a database, refer to [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html).
|
||||
- Review the information required to connect to the RDS DB instance. For more information, refer to [Connecting to an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_CommonTasks.Connect.html).
|
||||
|
||||
To configure Grafana for high availability, choose **one** of the following options:
|
||||
|
||||
- **Option 1:** Use `kubectl edit configmap grafana` to edit `grafana.ini` add the following section to the configuration:
|
||||
|
||||
```
|
||||
[database]
|
||||
type = [database type]
|
||||
host = [database address and port]
|
||||
name = [database name]
|
||||
user = [database username]
|
||||
password = [database password]
|
||||
```
|
||||
|
||||
- **Option 2:** use `kubectl edit deployment my-release` to edit the pod `env` variables and add the following database variables:
|
||||
|
||||
```
|
||||
- name: GF_DATABASE_TYPE
|
||||
value: [database type]
|
||||
- name: GF_DATABASE_HOST
|
||||
value: [database address and port]
|
||||
- name: GF_DATABASE_NAME
|
||||
value: [database name]
|
||||
- name: GF_DATABASE_USER
|
||||
value: [database username]
|
||||
- name: GF_DATABASE_PASSWORD
|
||||
value: [database password]
|
||||
```
|
||||
|
||||
For more information on Grafana High Availability setup, refer to [Set up Grafana for high availability]({{< relref "../../../../enterprise/setup-grafana/set-up-for-high-availability/" >}}).
|
||||
|
||||
## Task 3: Configure Grafana Enterprise to validate its license with AWS
|
||||
|
||||
In this task, you configure Grafana Enterprise to validate the license with AWS instead of Grafana Labs.
|
||||
|
||||
1. In AWS IAM, assign the following permissions to the Node IAM role (if you are using a Node Group), or the Pod Execution role (if you are using a Fargate profile):
|
||||
|
||||
- `"license-manager:CheckoutLicense"`
|
||||
- `"license-manager:ListReceivedLicenses"`
|
||||
- `"license-manager:GetLicenseUsage"`
|
||||
- `"license-manager:CheckInLicense"`
|
||||
|
||||
For more information about creating an access policy, refer to [Creating IAM policies (console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create-console.html).
|
||||
|
||||
For more information about AWS license permissions, refer to [Actions, resources, and condition keys for AWS License Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awslicensemanager.html).
|
||||
|
||||
1. Choose **one** of the following options to update the [license_validation_type]({{< relref "../../../../enterprise/setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type" >}}) configuration to `aws`:
|
||||
|
||||
- **Option 1:** Use `kubectl edit configmap grafana` to edit `grafana.ini` add the following section to the configuration:
|
||||
|
||||
```
|
||||
[enterprise]
|
||||
license_validation_type=aws
|
||||
```
|
||||
|
||||
- **Option 2:** Use `kubectl edit deployment my-release` to edit the pod `env` variables and add the following variable:
|
||||
|
||||
```
|
||||
name: GF_ENTERPRISE_LICENSE_VALIDATION_TYPE
|
||||
value: aws
|
||||
```
|
||||
|
||||
### Task 4: Start or restart Grafana
|
||||
|
||||
To activate Grafana Enterprise features, you must start (or restart) Grafana.
|
||||
|
||||
To restart Grafana on a Kubernetes cluster,
|
||||
|
||||
1. Run the command `kubectl rollout restart deployment my-release`.
|
||||
|
||||
1. After you update the service, navigate to your Grafana instance, sign in with Grafana Admin credentials, and navigate to the Statistics and Licensing page to validate that your license is active.
|
||||
|
||||
For more information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../../enterprise/setup-grafana/restart-grafana/" >}}).
|
||||
|
||||
> If you experience issues when you update the EKS cluster, refer to [Amazon EKS troubleshooting](https://docs.aws.amazon.com/eks/latest/userguide/troubleshooting.html).
|
||||
+130
@@ -0,0 +1,130 @@
|
||||
---
|
||||
aliases:
|
||||
- /docs/grafana/latest/enterprise/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/
|
||||
- /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/
|
||||
description: Activate a Grafana Enterprise license from AWS on an instance deployed
|
||||
outside of AWS
|
||||
keywords:
|
||||
- grafana
|
||||
- enterprise
|
||||
- aws
|
||||
- marketplace
|
||||
- activate
|
||||
title: Activate a Grafana Enterprise license from AWS on an instance deployed outside
|
||||
of AWS
|
||||
weight: 300
|
||||
---
|
||||
|
||||
# Activate a Grafana Enterprise license from AWS on an instance deployed outside of AWS
|
||||
|
||||
While AWS Marketplace lists ECS and EKS as the supported environments for Grafana Enterprise, you can apply a Grafana Enterprise license from AWS Marketplace to any Grafana instance with network access to the AWS licensing service.
|
||||
|
||||
## Before you begin
|
||||
|
||||
- Purchase a subscription to [Grafana Enterprise from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-dlncd4kzt5kx6).
|
||||
- Be sure that the IAM user that was used to purchase Grafana Enterprise has permission to manage subscriptions, create new IAM users, and create access policies.
|
||||
- Be sure there is network access between AWS and the environment where you intend to run Grafana. Network access is required because your Grafana instance communicates with the [AWS License Manager endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/licensemanager.html) to retrieve license and subscription information. Grafana instances with access to the public internet will have access to AWS license manager.
|
||||
|
||||
To activate a Grafana Enterprise license from AWS on a Grafana Enterprise instance deployed outside of AWS, complete the following tasks.
|
||||
|
||||
## Task 1: Install Grafana Enterprise
|
||||
|
||||
To install Grafana, refer to the documentation specific to your implementation.
|
||||
|
||||
- [Install Grafana]({{< relref "../../../../enterprise/setup-grafana/installation/" >}}).
|
||||
- [Run Grafana Docker image]({{< relref "../../../../enterprise/setup-grafana/installation/docker/" >}}).
|
||||
- [Deploy Grafana on Kubernetes]({{< relref "../../../../enterprise/setup-grafana/installation/kubernetes/#deploy-grafana-enterprise-on-kubernetes" >}}).
|
||||
|
||||
## Task 2: Create an AWS IAM user with access to your Grafana Enterprise license
|
||||
|
||||
To retrieve your license, Grafana Enterprise requires access to your AWS account and license information. To grant access, create an IAM user in AWS with access to the license, and pass its credentials as environment variables on the host or container where Grafana is running. These environment variables allow Grafana to retrieve license details from AWS.
|
||||
|
||||
1. In the AWS License Manager service, create an IAM policy with the following permissions:
|
||||
|
||||
- `"license-manager:CheckoutLicense"`
|
||||
- `"license-manager:ListReceivedLicenses"`
|
||||
- `"license-manager:GetLicenseUsage"`
|
||||
- `"license-manager:CheckInLicense"`
|
||||
|
||||
For more information about creating a policy in AWS, refer to [Creating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html).
|
||||
|
||||
For more information about AWS Identity and Access Management, refer to [IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html).
|
||||
|
||||
1. To limit the policy to obtain usage data just for Grafana Enterprise, in the **Resources** section of the policy, specify your license ARN.
|
||||
|
||||
You can find your license ID in the **Granted Licenses** section of [AWS License Manager](https://console.aws.amazon.com/license-manager/home).
|
||||
|
||||
The policy JSON should look similar to the following example:
|
||||
|
||||
```
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Sid": "VisualEditor0",
|
||||
"Effect": "Allow",
|
||||
"Action": "license-manager:GetLicenseUsage",
|
||||
"Resource": "arn:aws:license-manager::[YOUR_ACCOUNT]:license:[YOUR_LICENSE_ID]"
|
||||
},
|
||||
{
|
||||
"Sid": "VisualEditor1",
|
||||
"Effect": "Allow",
|
||||
"Action": [
|
||||
"license-manager:CheckoutLicense",
|
||||
"license-manager:ListReceivedLicenses",
|
||||
"license-manager:CheckInLicense"
|
||||
],
|
||||
"Resource": "*"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
1. Create an IAM user and choose access key credentials as its authentication method.
|
||||
|
||||
For more information about creating an IAM user, refer to [IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html).
|
||||
|
||||
For more information about access key credentials, refer to [Managing access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
|
||||
|
||||
1. Attach the policy you created to the IAM user.
|
||||
|
||||
1. Add the following values as environment variables to the host or container running Grafana:
|
||||
|
||||
- AWS region
|
||||
- IAM user's access key ID
|
||||
- IAM user's secret access key
|
||||
|
||||
The environment variables should look similar to the following example:
|
||||
|
||||
```
|
||||
AWS_ACCESS_KEY_ID=ABCD5E75FGHIJKTM7
|
||||
AWS_SECRET_ACCESS_KEY=k8fhYAQVy+5NhCejhe6HeSjSphjRuy+12C06
|
||||
AWS_REGION=us-east-1
|
||||
```
|
||||
|
||||
## Task 3: Configure Grafana Enterprise to validate its license with AWS
|
||||
|
||||
In this task you configure Grafana Enterprise to validate the license with AWS instead of Grafana Labs.
|
||||
|
||||
Choose one of the following options to update the [license_validation_type]({{< relref "../../../../enterprise/setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type" >}}) configuration to `aws`:
|
||||
|
||||
- **Option 1:** In the `[enterprise]` section of the grafana.ini configuration file, add `license_validation_type=aws`.
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
[enterprise]
|
||||
license_validation_type=aws
|
||||
```
|
||||
|
||||
- **Option 2:** Add the following environment variable to the container or host:
|
||||
|
||||
```
|
||||
GF_ENTERPRISE_LICENSE_VALIDATION_TYPE=aws
|
||||
```
|
||||
|
||||
## Task 4: Start or restart Grafana
|
||||
|
||||
To activate Grafana Enterprise features, start (or restart) Grafana.
|
||||
|
||||
For information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../../enterprise/setup-grafana/restart-grafana/" >}}).
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
---
|
||||
aliases:
|
||||
- /docs/grafana/latest/enterprise/activate-aws-marketplace-license/manage-license-in-aws-marketplace/
|
||||
- /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/manage-license-in-aws-marketplace/
|
||||
description: Manage your Grafana Enterprise license in AWS Marketplace
|
||||
keywords:
|
||||
- grafana
|
||||
- enterprise
|
||||
- aws
|
||||
- marketplace
|
||||
- manage
|
||||
- add
|
||||
- remove
|
||||
- users
|
||||
title: Manage your Grafana Enterprise license in AWS Marketplace
|
||||
weight: 400
|
||||
---
|
||||
|
||||
## Manage your Grafana Enterprise license in AWS Marketplace
|
||||
|
||||
You can use AWS Marketplace to make the following modifications to your Grafana Enterprise license:
|
||||
|
||||
- Add active users
|
||||
- Remove active users
|
||||
- Cancel your subscription to Grafana Enterprise.
|
||||
|
||||
**To modify your Grafana Enterprise subscription in AWS Marketplace:**
|
||||
|
||||
1. Open the AWS Console and navigate to [Subscription Management](https://console.aws.amazon.com/marketplace/home/subscriptions#/subscriptions).
|
||||
|
||||
1. Update your license.
|
||||
|
||||
1. Sign in to Grafana as a Server Administrator.
|
||||
|
||||
1. Hover over **Server Admin** in the navigation bar and click **Statistics and Licensing**.
|
||||
|
||||
1. In the **Token** section under **Enterprise License**, click **Renew License**.
|
||||
|
||||
This action retrieves updated license information from AWS.
|
||||
|
||||
> To learn more about licensing and active users, refer to [Understanding Grafana Enterprise licensing]({{< relref "../../../../enterprise/license/activate-aws-marketplace-license/license-restrictions/" >}}).
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
---
|
||||
aliases:
|
||||
- /docs/grafana/latest/enterprise/activate-aws-marketplace-license/transfer-ge-license/
|
||||
- /docs/grafana/latest/enterprise/license/activate-aws-marketplace-license/transfer-ge-license/
|
||||
description: Transfer your AWS Marketplace Grafana Enterprise license
|
||||
keywords:
|
||||
- grafana
|
||||
- enterprise
|
||||
- aws
|
||||
- marketplace
|
||||
- transfer
|
||||
- move
|
||||
title: Transfer your AWS Marketplace Grafana Enterprise license
|
||||
weight: 400
|
||||
---
|
||||
|
||||
# Transfer your AWS Marketplace Grafana Enterprise license
|
||||
|
||||
You can transfer your AWS Marketplace Grafana Enterprise license to another Grafana Enterprise instance. The transfer process requires that you first remove your license from one instance, and then apply the license to another instance.
|
||||
|
||||
> When you remove an Enterprise license, the system immediately disables all Grafana Enterprise features.
|
||||
|
||||
To remove an Enterprise license from a Grafana Enterprise instance, perform one of the following steps:
|
||||
|
||||
- If you are using Amazon ECS or Amazon EKS, remove the `GF_ENTERPRISE_LICENSE_VALIDATION_TYPE` environment variable from the container.
|
||||
- If you have deployed Grafana Enterprise outside of AWS, remove the `aws` license_validation_type value from the grafana.ini configuration file.
|
||||
|
||||
It can take the system up to one hour to clear the license. After the system clears the license, you can apply the same license to another Grafana Enterprise instance.
|
||||
|
||||
To determine that the system has returned your license, check the license details in AWS License Manager.
|
||||
Reference in New Issue
Block a user