expand docs for EKS-A subscriptions

aws · Oct 10, 2023 · 1153269 · 1153269
1 parent 6031822
commit 1153269
Show file tree

Hide file tree

Showing 8 changed files with 457 additions and 56 deletions.
diff --git a/docs/content/en/docs/clustermgmt/support/cluster-license.md b/docs/content/en/docs/clustermgmt/support/cluster-license.md
@@ -9,7 +9,72 @@ description: >
   Apply an EKS Anywhere Enterprise Subscription license to your EKS Anywhere cluster
 ---
 
-When you purchase an EKS Anywhere Enterprise Subscription, licenses for your clusters are provisioned in [AWS License Manager](https://docs.aws.amazon.com/license-manager/latest/userguide/license-manager.html) in the AWS account you used to purchase the subscription. After purchasing your subscription, navigate to the AWS License Manager console and accept the license grants following the steps in the [AWS License Manager documentation](https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html). Save the License ID strings for your licenses, as you will need them to license your clusters.
+When you purchase an EKS Anywhere Enterprise Subscription, licenses are provisioned in [AWS License Manager](https://docs.aws.amazon.com/license-manager/latest/userguide/license-manager.html) in the AWS account and region you used to purchase the subscription. After purchasing your subscription, you can view your licenses, accept the license grants, and apply the license IDs to your EKS Anywhere clusters. The License ID strings are used when you create support cases to validate your cluster is eligible to receive support.
+
+### View licenses for an EKS Anywhere subscription
+
+You can view the licenses associated with an EKS Anywhere Enterprise Subscription in the [Amazon EKS Console.](https://console.aws.amazon.com/eks/home#/eks-anywhere)
+
+Follow the step below to view EKS Anywhere licenses with the AWS CLI.
+
+**Get license ARNs based on subscription `name` with the AWS CLI**
+- Replace `region-code` with the AWS Region that hosts your subscription (for example `us-west-2`).
+- Replace `my-subscription` in the `--query` string with the `name` for your subscription.
+
+```bash
+aws eks list-eks-anywhere-subscriptions \
+  --region 'region-code' \
+  --query 'subscriptions[?name==`my-subscription`].licenseArns[]'
+```
+
+The License ID is the last part of the ARN string. For example, the License ID is shown in bold in the following example: *arn:aws:license-manager::12345678910:**license:l-4f36acf12e6d491484812927b327c066***
+
+**Get license details based a license ARN with the AWS CLI**
+
+- Replace `region-code` with the AWS Region that hosts your subscription (for example `us-west-2`).
+- Replace `my-license-arn` with the license ARN returned from the previous command.
+
+```bash
+aws license-manager get-license \
+  --region 'region-code'
+  --license-arn 'my-license-arn'
+```
+
+<details>
+  <summary>Expand for sample command output</summary>
+  <br /> 
+  {{% content "get-license-output.md" %}}
+</details>
+
+### Accept EKS Anywhere license grant
+
+You can accept the license grants associated with an EKS Anywhere Enterprise Subscription in the [AWS License Manager Console](https://console.aws.amazon.com/license-manager/) following the instructions in the [AWS License Manager documentation](https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html). 
+
+See the steps below for accepting EKS Anywhere license grants with the AWS CLI.
+
+**Get grant ARNs based on subscription `name` with the AWS CLI**
+
+- Replace `region-code` with the AWS Region that hosts your subscription (for example `us-west-2`).
+- Replace `my-subscription` in the `--query` string with the `name` for your subscription.
+
+```bash
+aws license-manager list-received-licenses \
+  --region 'region-code' \
+  --query 'Licenses[?LicenseName==`EKS Anywhere license for subscription my-subscription`].LicenseMetadata[].Value'
+```
+
+**Accept the license grant with the AWS CLI**
+
+- Replace `region-code` with the AWS Region that hosts your subscription (for example `us-west-2`).
+- Replace `my-grant-arn` with the grant ARN returned from the previous command. If you have multiple grants, repeat for each grant ARN.
+
+```bash
+aws license-manager accept-grant \
+  --region 'region-code' \
+  --grant-arn 'my-grant-arn'
+```
+
+### Apply a license to an EKS Anywhere cluster
 
 You can apply a license to an EKS Anywhere cluster during or after cluster creation for standalone or management clusters. For workload clusters, you must apply the license after cluster creation. A license can only be bound to one EKS Anywhere cluster at a time, and you can only receive support for your EKS Anywhere cluster if it has a valid and active license. In the examples below, the `<license-id-string>` is the License ID, for example `l-93ea2875c88f455288737835fa0abbc8`.
 

diff --git a/docs/content/en/docs/clustermgmt/support/create-subscription-output.md b/docs/content/en/docs/clustermgmt/support/create-subscription-output.md
@@ -0,0 +1,28 @@
+---
+toc_hide: true
+---
+  ```
+  {
+      "subscription": {
+          "id": "e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964",
+          "arn": "arn:aws:eks:us-west-2:405717325709:eks-anywhere-subscription/e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964",
+          "name": "my-subscription",
+          "createdAt": "2023-10-10T08:33:36.869000-05:00",
+          "effectiveDate": "2023-10-10T08:33:36.869000-05:00",
+          "expirationDate": "2024-10-10T08:33:36.869000-05:00",
+          "licenseQuantity": 1,
+          "licenseType": "CLUSTER",
+          "term": {
+              "duration": 12,
+              "unit": "MONTHS"
+          },
+          "status": "CREATING",
+          "packageRegistry": "067575901363.dkr.ecr.us-west-2.amazonaws.com",
+          "autoRenew": false,
+          "licenseArns": [],
+          "tags": {
+              "environment": "prod"
+          }
+      }
+  }
+  ```
diff --git a/docs/content/en/docs/clustermgmt/support/describe-subscription-output.md b/docs/content/en/docs/clustermgmt/support/describe-subscription-output.md
@@ -0,0 +1,31 @@
+---
+toc_hide: true
+---
+
+```
+{
+    "subscription": {
+        "id": "e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964",
+        "arn": "arn:aws:eks:us-west-2:405717325709:eks-anywhere-subscription/e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964",
+        "name": "my-subscription",
+        "createdAt": "2023-10-10T08:33:36.869000-05:00",
+        "effectiveDate": "2023-10-10T08:33:36.869000-05:00",
+        "expirationDate": "2024-10-10T08:33:36.869000-05:00",
+        "licenseQuantity": 1,
+        "licenseType": "CLUSTER",
+        "term": {
+            "duration": 12,
+            "unit": "MONTHS"
+        },
+        "status": "ACTIVE",
+        "packageRegistry": "067575901363.dkr.ecr.us-west-2.amazonaws.com",
+        "autoRenew": false,
+        "licenseArns": [
+            "arn:aws:license-manager::924750122622:license:l-4f36acf12e6d491484812927b327c066"
+        ],
+        "tags": {
+            "environment": "prod"
+        }
+    }
+}
+```
diff --git a/docs/content/en/docs/clustermgmt/support/get-license-output.md b/docs/content/en/docs/clustermgmt/support/get-license-output.md
@@ -0,0 +1,43 @@
+---
+toc_hide: true
+---
+
+```
+{
+    "License": {
+        "LicenseArn": "arn:aws:license-manager::12345678910:license:l-4f36acf12e6d491484812927b327c066",
+        "LicenseName": "EKS Anywhere license for subscription my-subscription",
+        "ProductName": "Amazon EKS Anywhere",
+        "ProductSKU": "EKS Anywhere e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964:9444bd0d",
+        "Issuer": {
+            "Name": "Amazon EKS Anywhere",
+            "KeyFingerprint": "aws:12345678910:Amazon EKS Anywhere:issuer-fingerprint"
+        },
+        "HomeRegion": "us-west-2",
+        "Status": "AVAILABLE",
+        "Validity": {
+            "Begin": "2023-10-10T13:33:36.000Z",
+            "End": "2024-10-11T13:33:36.000Z"
+        },
+        "Beneficiary": "12345678910",
+        "Entitlements": [
+            {
+                "Name": "EKS Anywhere for e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964",
+                "MaxCount": 1,
+                "Overage": false,
+                "Unit": "Count",
+                "AllowCheckIn": false
+            }
+        ],
+        "ConsumptionConfiguration": {
+            "RenewType": "None",
+            "BorrowConfiguration": {
+                "AllowEarlyCheckIn": true,
+                "MaxTimeToLiveInMinutes": 527040
+            }
+        },
+        "CreateTime": "1696945150",
+        "Version": "1"
+    }
+}
+```
diff --git a/docs/content/en/docs/clustermgmt/support/list-subscription-output.md b/docs/content/en/docs/clustermgmt/support/list-subscription-output.md
@@ -0,0 +1,33 @@
+---
+toc_hide: true
+---
+
+```
+{
+    "subscriptions": [
+        {
+            "id": "e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964",
+            "arn": "arn:aws:eks:us-west-2:405717325709:eks-anywhere-subscription/e29fd0d2-d8a8-4ed4-be54-c6c0dd0f7964",
+            "name": "my-subscription",
+            "createdAt": "2023-10-10T08:33:36.869000-05:00",
+            "effectiveDate": "2023-10-10T08:33:36.869000-05:00",
+            "expirationDate": "2024-10-10T08:33:36.869000-05:00",
+            "licenseQuantity": 1,
+            "licenseType": "CLUSTER",
+            "term": {
+                "duration": 12,
+                "unit": "MONTHS"
+            },
+            "status": "ACTIVE",
+            "packageRegistry": "067575901363.dkr.ecr.us-west-2.amazonaws.com",
+            "autoRenew": false,
+            "licenseArns": [
+                "arn:aws:license-manager::924750122622:license:l-4f36acf12e6d491484812927b327c066"
+            ],
+            "tags": {
+                "environment": "prod"
+            }
+        }
+    ]
+}
+```