-{{< img src="customer-portal.png" alt="Customer portal for enterprise support" class="img-fluid shadow rounded" width="800px" >}} -
- -### Signing up for Enterprise Support - -If you are a member of an organization with an enterprise LocalStack subscription, you will receive an invitation to create an account and join the LocalStack Support Portal via email. - -Follow the instructions in the email and set up your account by clicking on the **Sign up** button. -You will be asked to create a password. -Once you do so, you will be able to log in and start using the customer portal to create, view, and engage with tickets. - -### Creating a Support Ticket - -You can open a new ticket with LocalStack support by going to the **Create a Support Ticket** link. -You will be redirected to a form where you will have to provide certain information to file a new support ticket. - --{{< img src="file-a-support-ticket.png" alt="Filing a support ticket" class="img-fluid shadow rounded" width="800px" >}} -
- -The form consists of two parts. -One is basic information, which is mandatory to fill out, and additional information, which adds more context to your issue but is not mandatory. -Once all the mandatory fields are filled out, you can create a new support ticket by clicking on the Submit button. -Once the ticket is submitted, it will be reported to LocalStack support, who will get back to you on that query as soon as possible. -A ticket will show up in the ticket list as soon as it’s submitted. - -#### Basic Information - -You need to fill out the following fields, which are mandatory to open a new ticket: - -- **Type** - Choose the type of your query from the following options: - - **Issue** - Select this when you are facing an issue using LocalStack. - - **General inquiry** - Select this when you have a general question regarding LocalStack. - - **Feature request** - Select this when you are looking for a feature that is not yet implemented in LocalStack. -- **Ticket name** - Provide a descriptive name for the ticket that summarizes your inquiry. -- **Description** - Provide a comprehensive description of your inquiry, explaining all the details that will help us understand your query. - -#### Additional Information - -- **CI Issue?** - If the query is related to a CI issue, select the one that best fits your query from the dropdown. -- **Operating system** - From the dropdown, select the operating system you are using. -- **Affected Services** - From the dropdown, select the AWS service that is affected in your query. -- **File upload** - Here you can provide any additional files that you believe would be helpful for LocalStack support (e.g., screenshots, log files, etc.). +To learn more about the support available to **Enterprise** plan users, refer to the [Enterprise Support]({{}}) page. diff --git a/content/en/user-guide/localstack-enterprise/_index.md b/content/en/user-guide/localstack-enterprise/_index.md new file mode 100644 index 0000000000..c36bc1ee7f --- /dev/null +++ b/content/en/user-guide/localstack-enterprise/_index.md @@ -0,0 +1,9 @@ +--- +title: "LocalStack Enterprise" +linkTitle: "LocalStack Enterprise" +weight: 60 +description: > + LocalStack Enterprise provides the most sophisticated and secure setup we offer, with advanced features and capabilities for large organizations and teams. This section provides guides and resources to help you get started with LocalStack Enterprise. +cascade: + type: docs +--- diff --git a/content/en/user-guide/web-application/ci-analytics/ci-project-runs.png b/content/en/user-guide/localstack-enterprise/ci-analytics/ci-project-runs.png similarity index 100% rename from content/en/user-guide/web-application/ci-analytics/ci-project-runs.png rename to content/en/user-guide/localstack-enterprise/ci-analytics/ci-project-runs.png diff --git a/content/en/user-guide/web-application/ci-analytics/create-new-project.png b/content/en/user-guide/localstack-enterprise/ci-analytics/create-new-project.png similarity index 100% rename from content/en/user-guide/web-application/ci-analytics/create-new-project.png rename to content/en/user-guide/localstack-enterprise/ci-analytics/create-new-project.png diff --git a/content/en/user-guide/web-application/ci-analytics/index.md b/content/en/user-guide/localstack-enterprise/ci-analytics/index.md similarity index 99% rename from content/en/user-guide/web-application/ci-analytics/index.md rename to content/en/user-guide/localstack-enterprise/ci-analytics/index.md index 9bb5cb1bc2..d472e75ed9 100644 --- a/content/en/user-guide/web-application/ci-analytics/index.md +++ b/content/en/user-guide/localstack-enterprise/ci-analytics/index.md @@ -6,6 +6,7 @@ description: Get insights into your continuous integration (CI) builds with Loca tags: ["Enterprise plan"] aliases: - /user-guide/ci/ci-analytics/ + - /user-guide/web-application/ci-analytics/ --- ## Introduction diff --git a/content/en/user-guide/web-application/ci-analytics/localstack-ci-run-details.png b/content/en/user-guide/localstack-enterprise/ci-analytics/localstack-ci-run-details.png similarity index 100% rename from content/en/user-guide/web-application/ci-analytics/localstack-ci-run-details.png rename to content/en/user-guide/localstack-enterprise/ci-analytics/localstack-ci-run-details.png diff --git a/content/en/user-guide/web-application/ci-analytics/request-response-traces-test.png b/content/en/user-guide/localstack-enterprise/ci-analytics/request-response-traces-test.png similarity index 100% rename from content/en/user-guide/web-application/ci-analytics/request-response-traces-test.png rename to content/en/user-guide/localstack-enterprise/ci-analytics/request-response-traces-test.png diff --git a/content/en/user-guide/web-application/ci-analytics/request-response-traces.png b/content/en/user-guide/localstack-enterprise/ci-analytics/request-response-traces.png similarity index 100% rename from content/en/user-guide/web-application/ci-analytics/request-response-traces.png rename to content/en/user-guide/localstack-enterprise/ci-analytics/request-response-traces.png diff --git a/content/en/user-guide/localstack-enterprise/enterprise-image/index.md b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md new file mode 100644 index 0000000000..364be15cef --- /dev/null +++ b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md @@ -0,0 +1,32 @@ +--- +title: "Enterprise Image" +linkTitle: "Enterprise Image" +weight: 1 +description: Custom LocalStack Enterprise image for offline or air-gapped environments with preferred configurations and packages. +tags: ["Enterprise plan"] +--- + +## Introduction + +LocalStack offers an Enterprise image that allows offline usage and includes a customer-specific configuration. +This offline functionality is enabled by: + +- Pre-installed packages required for running specific services that are usually downloaded on demand (such as `opensearch` or `dynamodb-local`). +- A certificate keypair for `localhost.localstack.cloud` to resolve to the LocalStack container via our DNS server. +- An embedded decryption key in the image, eliminating the need to contact the license server to operate LocalStack. + +## Why use Enterprise Image? + +- **Airgapped environments**: The Enterprise image is ideal for customers who operate in airgapped environments where internet access is restricted. +- **Security Fixes**: The Enterprise image is updated with the latest security fixes and patches including container image scans on a priority basis. +- **Custom Configuration**: The Enterprise image can be customized to include specific packages and configurations required by the customer. +- **CI Usage**: The Enterprise image can be used in CI/CD pipelines to ensure that the same image is used across all environments. + +## How to use the image? + +- After the image is pushed to the customer-specific ECR repository, the customer can pull and push it to their internal Docker registry. +- Developers within the customer’s network can then pull the image from this registry. +- To use the image from the command line interface (CLI), set the `IMAGE_NAME` configuration to the name of the Enterprise image, typically using the command: + {{< command >}} + $ IMAGE_NAME=localstack-enterprise localstack start + {{< / command >}} diff --git a/content/en/getting-started/help-and-support/customer-portal.png b/content/en/user-guide/localstack-enterprise/enterprise-support/customer-portal.png similarity index 100% rename from content/en/getting-started/help-and-support/customer-portal.png rename to content/en/user-guide/localstack-enterprise/enterprise-support/customer-portal.png diff --git a/content/en/getting-started/help-and-support/file-a-support-ticket.png b/content/en/user-guide/localstack-enterprise/enterprise-support/file-a-support-ticket.png similarity index 100% rename from content/en/getting-started/help-and-support/file-a-support-ticket.png rename to content/en/user-guide/localstack-enterprise/enterprise-support/file-a-support-ticket.png diff --git a/content/en/user-guide/localstack-enterprise/enterprise-support/index.md b/content/en/user-guide/localstack-enterprise/enterprise-support/index.md new file mode 100644 index 0000000000..ba10f991ce --- /dev/null +++ b/content/en/user-guide/localstack-enterprise/enterprise-support/index.md @@ -0,0 +1,59 @@ +--- +title: "Enterprise Support" +linkTitle: "Enterprise Support" +weight: 3 +description: +tags: ["Enterprise plan"] +--- + +## Introduction + +A customer portal is a home behind a login where customers can view, open, and reply to their support tickets. +Currently, the **customer portal** is only **available to Enterprise customers**. + +You can find the customer portal here: [https://support.localstack.cloud/portal](https://support.localstack.cloud/portal) + ++{{< img src="customer-portal.png" alt="Customer portal for enterprise support" class="img-fluid shadow rounded" width="800px" >}} +
+ +## Signing up for Enterprise Support + +If you are a member of an organization with an enterprise LocalStack subscription, you will receive an invitation to create an account and join the LocalStack Support Portal via email. + +Follow the instructions in the email and set up your account by clicking on the **Sign up** button. +You will be asked to create a password. +Once you do so, you will be able to log in and start using the customer portal to create, view, and engage with tickets. + +## Creating a Support Ticket + +You can open a new ticket with LocalStack support by going to the **Create a Support Ticket** link. +You will be redirected to a form where you will have to provide certain information to file a new support ticket. + ++{{< img src="file-a-support-ticket.png" alt="Filing a support ticket" class="img-fluid shadow rounded" width="800px" >}} +
+ +The form consists of two parts. +One is basic information, which is mandatory to fill out, and additional information, which adds more context to your issue but is not mandatory. +Once all the mandatory fields are filled out, you can create a new support ticket by clicking on the Submit button. +Once the ticket is submitted, it will be reported to LocalStack support, who will get back to you on that query as soon as possible. +A ticket will show up in the ticket list as soon as it’s submitted. + +### Basic Information + +You need to fill out the following fields, which are mandatory to open a new ticket: + +- **Type** - Choose the type of your query from the following options: + - **Issue** - Select this when you are facing an issue using LocalStack. + - **General inquiry** - Select this when you have a general question regarding LocalStack. + - **Feature request** - Select this when you are looking for a feature that is not yet implemented in LocalStack. +- **Ticket name** - Provide a descriptive name for the ticket that summarizes your inquiry. +- **Description** - Provide a comprehensive description of your inquiry, explaining all the details that will help us understand your query. + +### Additional Information + +- **CI Issue?** - If the query is related to a CI issue, select the one that best fits your query from the dropdown. +- **Operating system** - From the dropdown, select the operating system you are using. +- **Affected Services** - From the dropdown, select the AWS service that is affected in your query. +- **File upload** - Here you can provide any additional files that you believe would be helpful for LocalStack support (e.g., screenshots, log files, etc.). diff --git a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md new file mode 100644 index 0000000000..423c55f897 --- /dev/null +++ b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md @@ -0,0 +1,144 @@ +--- +title: "K8s Operator" +linkTitle: "K8s Operator" +weight: 2 +description: Custom K8s operator that offers LocalStack emulator as a native resource in Kubernetes environments. +tags: ["Enterprise plan"] +--- + +## Introduction + +LocalStack K8s operator is a custom Kubernetes operator that offers LocalStack emulator as a native resource in Kubernetes environments. +The operator is designed to simplify the deployment and management of LocalStack in Kubernetes clusters. + +## Installation + +To install the K8s operator, run the following commands: + +{{< command >}} +$ kubectl apply -f https://raw.githubusercontent.com/localstack/localstack-k8s-operator/v0.2.0/release/crds.yaml +$ kubectl apply -f https://raw.githubusercontent.com/localstack/localstack-k8s-operator/v0.2.0/release/controller.yaml +{{< / command >}} + +You can then deploy a LocalStack instance by storing the following file content as `localstack.yml` and applying it against the cluster via `kubectl apply -f localstack.yml`. + +```bash +apiVersion: api.localstack.cloud/v1alpha1 +kind: LocalStack +metadata: + name: env-0 + namespace: default +spec: + image: localstack/localstack-pro:3.5.0 + debug: trace + + authToken: "