Skip to content

setup the enterprise docs #1385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jul 26, 2024
50 changes: 1 addition & 49 deletions content/en/getting-started/help-and-support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,52 +125,4 @@ Ensure that you avoid sending the diagnostic output to public channels or forums

## Enterprise Support

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)

<p>
{{< img src="customer-portal.png" alt="Customer portal for enterprise support" class="img-fluid shadow rounded" width="800px" >}}
</p>

### 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.

<p>
{{< img src="file-a-support-ticket.png" alt="Filing a support ticket" class="img-fluid shadow rounded" width="800px" >}}
</p>

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]({{<ref "enterprise-support" >}}) page.
9 changes: 9 additions & 0 deletions content/en/user-guide/localstack-enterprise/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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 >}}
Original file line number Diff line number Diff line change
@@ -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)

<p>
{{< img src="customer-portal.png" alt="Customer portal for enterprise support" class="img-fluid shadow rounded" width="800px" >}}
</p>

## 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.

<p>
{{< img src="file-a-support-ticket.png" alt="Filing a support ticket" class="img-fluid shadow rounded" width="800px" >}}
</p>

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.).
144 changes: 144 additions & 0 deletions content/en/user-guide/localstack-enterprise/k8s-operator/index.md
Original file line number Diff line number Diff line change
@@ -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: "<my-auth-token>" # Set your LocalStack auth token here
autoLoadPods: ["<my-cloudpod>"] # Set your Cloud Pods to automatically load them here (optional)

dnsProvider: coredns
dnsConfigName: coredns
dnsConfigNamespace: kube-system
```

## API Reference

### Resource Types

- [LocalStack](#localstack)
- [LocalStackList](#localstacklist)

#### Hooks

_Appears in:_
- [LocalStackSpec](#localstackspec)

| Field | Description |
| --- | --- |
| `readyConfigName` _string_ | |
| `bootConfigName` _string_ | |
| `shutdownConfigName` _string_ | |
| `startConfigName` _string_ | |

Use as described in the [Initialization Hooks](https://docs.localstack.cloud/references/init-hooks/) reference.

#### LocalStack

LocalStack is the Schema for the `localstacks` API

_Appears in:_
- [LocalStackList](#localstacklist)

| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `api.localstack.cloud/v1alpha1`
| `kind` _string_ | `LocalStack`
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br /><br />Servers may infer this from the endpoint the client submits requests to.<br /><br />Cannot be updated.<br /><br />In CamelCase.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br /><br />Servers should convert recognized schemas to the latest internal value, and<br /><br />may reject unrecognized values.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` _[LocalStackSpec](#localstackspec)_ | |
| `status` _[LocalStackStatus](#localstackstatus)_ | |

#### LocalStackList

LocalStackList contains a list of LocalStack

| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `api.localstack.cloud/v1alpha1`
| `kind` _string_ | `LocalStackList`
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br /><br />Servers may infer this from the endpoint the client submits requests to.<br /><br />Cannot be updated.<br /><br />In CamelCase.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br /><br />Servers should convert recognized schemas to the latest internal value, and<br /><br />may reject unrecognized values.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[LocalStack](#localstack) array_ | |

#### LocalStackSpec

LocalStackSpec defines the desired state of LocalStack

_Appears in:_
- [LocalStack](#localstack)

| Field | Description |
| --- | --- |
| `dnsProvider` _string_ | |
| `dnsConfigName` _string_ | |
| `dnsConfigNamespace` _string_ | |
| `debug` _string_ | |
| `autoLoadPods` _string array_ | |
| `authToken` _string_ | |
| `hooks` _[Hooks](#hooks)_ | |
| `image` _string_ | Validate docker inage name (with optional tag and registry address) |
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#resourcerequirements-v1-core)_ | |
| `readiness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | |
| `liveness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | |
| `envFrom` _[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envfromsource-v1-core) array_ | |
| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envvar-v1-core) array_ | |
| `dnsPolicy` _[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#dnspolicy-v1-core)_ | |

#### LocalStackStatus

LocalStackStatus defines the observed state of LocalStack

_Appears in:_
- [LocalStack](#localstack)

| Field | Description |
| --- | --- |
| `ready` _boolean_ | |
| `ip` _string_ | |
| `dns` _string_ | |

#### PodSpec

_Appears in:_
- [LocalStackSpec](#localstackspec)

| Field | Description |
| --- | --- |
| `image` _string_ | Validate docker inage name (with optional tag and registry address) |
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#resourcerequirements-v1-core)_ | |
| `readiness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | |
| `liveness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | |
| `envFrom` _[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envfromsource-v1-core) array_ | |
| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envvar-v1-core) array_ | |
| `dnsPolicy` _[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#dnspolicy-v1-core)_ | |
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "Single-Sign On"
weight: 200
weight: 4
description: >
Configuring Custom Single-Sign On (SSO) Providers in LocalStack Web Application
tags: ["Enterprise plan"]
aliases:
- /user-guide/web-application/single-sign-on/
---

Custom Single-Sign On (SSO) Identity providers, can be enabled to facilitate the process of quickly onboarding team members from your organization.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "SSO for Azure AD"
tags: ["Enterprise plan"]
weight: 5
weight: 1
description: >
Configuring Azure AD for Single Sign-on in LocalStack Enterprise
aliases:
- /user-guide/web-application/single-sign-on/azure-ad/
---

To configure SSO with an Azure AD Enterprise application, we provide a simple step-by-step solution below:
Expand Down