From ce311e9718adbbf9f05d43988bc5f9f56de0d4e0 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Wed, 17 Jul 2024 17:16:12 +0530 Subject: [PATCH 01/12] setup the enterprise docs --- content/en/user-guide/enterprise-guides/_index.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 content/en/user-guide/enterprise-guides/_index.md diff --git a/content/en/user-guide/enterprise-guides/_index.md b/content/en/user-guide/enterprise-guides/_index.md new file mode 100644 index 0000000000..d4cbcc01fc --- /dev/null +++ b/content/en/user-guide/enterprise-guides/_index.md @@ -0,0 +1,9 @@ +--- +title: "Enterprise Guides" +linkTitle: "Enterprise Guides" +weight: 50 +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 +--- From 17bd020d506f237e218efeba76aa7fc5afb0bfa3 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Wed, 17 Jul 2024 17:57:56 +0530 Subject: [PATCH 02/12] add basic docs on enterprise image (wip) --- .../enterprise-image/index.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 content/en/user-guide/enterprise-guides/enterprise-image/index.md diff --git a/content/en/user-guide/enterprise-guides/enterprise-image/index.md b/content/en/user-guide/enterprise-guides/enterprise-image/index.md new file mode 100644 index 0000000000..d8eb3e5cd3 --- /dev/null +++ b/content/en/user-guide/enterprise-guides/enterprise-image/index.md @@ -0,0 +1,23 @@ +--- +title: "Enterprise Image" +linkTitle: "Enterprise Image" +weight: 1 +description: Custom LocalStack Enterprise image for offline or air-gapped environments with preferred configurations and packages. +--- + +## 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. + +## 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 >}} From 1f2f6e44d43bc76e19d82541ad5702c2ae7abbdd Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Wed, 17 Jul 2024 18:55:34 +0530 Subject: [PATCH 03/12] rename to localstack enterprise --- .../{enterprise-guides => localstack-enterprise}/_index.md | 6 +++--- .../enterprise-image/index.md | 0 .../user-guide/localstack-enterprise/k8s-operator/index.md | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename content/en/user-guide/{enterprise-guides => localstack-enterprise}/_index.md (79%) rename content/en/user-guide/{enterprise-guides => localstack-enterprise}/enterprise-image/index.md (100%) create mode 100644 content/en/user-guide/localstack-enterprise/k8s-operator/index.md diff --git a/content/en/user-guide/enterprise-guides/_index.md b/content/en/user-guide/localstack-enterprise/_index.md similarity index 79% rename from content/en/user-guide/enterprise-guides/_index.md rename to content/en/user-guide/localstack-enterprise/_index.md index d4cbcc01fc..c36bc1ee7f 100644 --- a/content/en/user-guide/enterprise-guides/_index.md +++ b/content/en/user-guide/localstack-enterprise/_index.md @@ -1,7 +1,7 @@ --- -title: "Enterprise Guides" -linkTitle: "Enterprise Guides" -weight: 50 +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: diff --git a/content/en/user-guide/enterprise-guides/enterprise-image/index.md b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md similarity index 100% rename from content/en/user-guide/enterprise-guides/enterprise-image/index.md rename to content/en/user-guide/localstack-enterprise/enterprise-image/index.md 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..e69de29bb2 From db2e95f9b5fe6bc4bdad1bfc1405b71a59129bff Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Wed, 17 Jul 2024 19:08:44 +0530 Subject: [PATCH 04/12] add docs on k8s operator --- .../k8s-operator/index.md | 144 ++++++++++++++++++ 1 file changed, 144 insertions(+) diff --git a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md index e69de29bb2..343a4f9b19 100644 --- a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md +++ 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. +--- + +## 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 in the following manner: + +```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: "" # Set your LocalStack auth token here + autoLoadPods: [""] # Set your Cloud Pods to automatically load them here + + 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.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

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.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

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.

Servers may infer this from the endpoint the client submits requests to.

Cannot be updated.

In CamelCase.

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.

Servers should convert recognized schemas to the latest internal value, and

may reject unrecognized values.

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)_ | | From c849c537ce6367d98aa8559a7f28e7d905c6abf3 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Wed, 17 Jul 2024 19:13:56 +0530 Subject: [PATCH 05/12] add enterprise plan tag --- .../user-guide/localstack-enterprise/enterprise-image/index.md | 1 + .../en/user-guide/localstack-enterprise/k8s-operator/index.md | 1 + 2 files changed, 2 insertions(+) diff --git a/content/en/user-guide/localstack-enterprise/enterprise-image/index.md b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md index d8eb3e5cd3..7fa542901e 100644 --- a/content/en/user-guide/localstack-enterprise/enterprise-image/index.md +++ b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md @@ -3,6 +3,7 @@ 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 diff --git a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md index 343a4f9b19..be68d3baa9 100644 --- a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md +++ b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md @@ -3,6 +3,7 @@ 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 From 7a069f2a30ce349b293bc657a91706fcb44c2b32 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Wed, 17 Jul 2024 19:23:46 +0530 Subject: [PATCH 06/12] add enterprise support docs --- .../getting-started/help-and-support/index.md | 50 +---------------- .../enterprise-support}/customer-portal.png | Bin .../file-a-support-ticket.png | Bin .../enterprise-support/index.md | 51 ++++++++++++++++++ 4 files changed, 52 insertions(+), 49 deletions(-) rename content/en/{getting-started/help-and-support => user-guide/localstack-enterprise/enterprise-support}/customer-portal.png (100%) rename content/en/{getting-started/help-and-support => user-guide/localstack-enterprise/enterprise-support}/file-a-support-ticket.png (100%) create mode 100644 content/en/user-guide/localstack-enterprise/enterprise-support/index.md diff --git a/content/en/getting-started/help-and-support/index.md b/content/en/getting-started/help-and-support/index.md index b0edd0510a..4378985103 100644 --- a/content/en/getting-started/help-and-support/index.md +++ b/content/en/getting-started/help-and-support/index.md @@ -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) - -

-{{< 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/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..a8b77adfdb --- /dev/null +++ b/content/en/user-guide/localstack-enterprise/enterprise-support/index.md @@ -0,0 +1,51 @@ +--- +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.). From 8885bc7e858b2e4726ea963691f776ecfd3c54f4 Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Mon, 22 Jul 2024 23:05:24 +0530 Subject: [PATCH 07/12] move sso docs to enterprise docs --- .../single-sign-on/_index.md | 4 +++- .../single-sign-on/additional-information-page.png | Bin .../single-sign-on/attribute-mapping.png | Bin .../single-sign-on/azure-ad/azure-step-1.png | Bin .../single-sign-on/azure-ad/azure-step-2.png | Bin .../single-sign-on/azure-ad/azure-step-3.png | Bin .../single-sign-on/azure-ad/azure-step-4.png | Bin .../single-sign-on/azure-ad/index.md | 4 +++- .../single-sign-on/localstack-setting-sso.png | Bin .../single-sign-on/oidc-sso.png | Bin .../single-sign-on/roles-permissions.png | Bin .../single-sign-on/saml-sso.png | Bin 12 files changed, 6 insertions(+), 2 deletions(-) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/_index.md (98%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/additional-information-page.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/attribute-mapping.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/azure-ad/azure-step-1.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/azure-ad/azure-step-2.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/azure-ad/azure-step-3.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/azure-ad/azure-step-4.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/azure-ad/index.md (95%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/localstack-setting-sso.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/oidc-sso.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/roles-permissions.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/single-sign-on/saml-sso.png (100%) diff --git a/content/en/user-guide/web-application/single-sign-on/_index.md b/content/en/user-guide/localstack-enterprise/single-sign-on/_index.md similarity index 98% rename from content/en/user-guide/web-application/single-sign-on/_index.md rename to content/en/user-guide/localstack-enterprise/single-sign-on/_index.md index 81be5d38df..13cfc4ad2c 100644 --- a/content/en/user-guide/web-application/single-sign-on/_index.md +++ b/content/en/user-guide/localstack-enterprise/single-sign-on/_index.md @@ -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. diff --git a/content/en/user-guide/web-application/single-sign-on/additional-information-page.png b/content/en/user-guide/localstack-enterprise/single-sign-on/additional-information-page.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/additional-information-page.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/additional-information-page.png diff --git a/content/en/user-guide/web-application/single-sign-on/attribute-mapping.png b/content/en/user-guide/localstack-enterprise/single-sign-on/attribute-mapping.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/attribute-mapping.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/attribute-mapping.png diff --git a/content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-1.png b/content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-1.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-1.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-1.png diff --git a/content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-2.png b/content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-2.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-2.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-2.png diff --git a/content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-3.png b/content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-3.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-3.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-3.png diff --git a/content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-4.png b/content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-4.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/azure-ad/azure-step-4.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/azure-step-4.png diff --git a/content/en/user-guide/web-application/single-sign-on/azure-ad/index.md b/content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/index.md similarity index 95% rename from content/en/user-guide/web-application/single-sign-on/azure-ad/index.md rename to content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/index.md index 8259402305..298c1602c1 100644 --- a/content/en/user-guide/web-application/single-sign-on/azure-ad/index.md +++ b/content/en/user-guide/localstack-enterprise/single-sign-on/azure-ad/index.md @@ -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: diff --git a/content/en/user-guide/web-application/single-sign-on/localstack-setting-sso.png b/content/en/user-guide/localstack-enterprise/single-sign-on/localstack-setting-sso.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/localstack-setting-sso.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/localstack-setting-sso.png diff --git a/content/en/user-guide/web-application/single-sign-on/oidc-sso.png b/content/en/user-guide/localstack-enterprise/single-sign-on/oidc-sso.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/oidc-sso.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/oidc-sso.png diff --git a/content/en/user-guide/web-application/single-sign-on/roles-permissions.png b/content/en/user-guide/localstack-enterprise/single-sign-on/roles-permissions.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/roles-permissions.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/roles-permissions.png diff --git a/content/en/user-guide/web-application/single-sign-on/saml-sso.png b/content/en/user-guide/localstack-enterprise/single-sign-on/saml-sso.png similarity index 100% rename from content/en/user-guide/web-application/single-sign-on/saml-sso.png rename to content/en/user-guide/localstack-enterprise/single-sign-on/saml-sso.png From f5becea91cdcd89165450bcc4e4decd53ff75e7a Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Mon, 22 Jul 2024 23:09:08 +0530 Subject: [PATCH 08/12] move ci analytics to enterprise docs --- .../ci-analytics/ci-project-runs.png | Bin .../ci-analytics/create-new-project.png | Bin .../ci-analytics/index.md | 1 + .../ci-analytics/localstack-ci-run-details.png | Bin .../ci-analytics/request-response-traces-test.png | Bin .../ci-analytics/request-response-traces.png | Bin 6 files changed, 1 insertion(+) rename content/en/user-guide/{web-application => localstack-enterprise}/ci-analytics/ci-project-runs.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/ci-analytics/create-new-project.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/ci-analytics/index.md (99%) rename content/en/user-guide/{web-application => localstack-enterprise}/ci-analytics/localstack-ci-run-details.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/ci-analytics/request-response-traces-test.png (100%) rename content/en/user-guide/{web-application => localstack-enterprise}/ci-analytics/request-response-traces.png (100%) 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 From 7d1ace7de6c5dfa10f7b0134f09856f219a5d10b Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Mon, 22 Jul 2024 23:14:28 +0530 Subject: [PATCH 09/12] format the docs --- .../enterprise-image/index.md | 3 +- .../enterprise-support/index.md | 40 +++++++++++-------- .../k8s-operator/index.md | 5 +-- 3 files changed, 28 insertions(+), 20 deletions(-) diff --git a/content/en/user-guide/localstack-enterprise/enterprise-image/index.md b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md index 7fa542901e..32e7af3d59 100644 --- a/content/en/user-guide/localstack-enterprise/enterprise-image/index.md +++ b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md @@ -8,7 +8,8 @@ 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: +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. diff --git a/content/en/user-guide/localstack-enterprise/enterprise-support/index.md b/content/en/user-guide/localstack-enterprise/enterprise-support/index.md index a8b77adfdb..ba10f991ce 100644 --- a/content/en/user-guide/localstack-enterprise/enterprise-support/index.md +++ b/content/en/user-guide/localstack-enterprise/enterprise-support/index.md @@ -8,7 +8,8 @@ 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**. +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) @@ -20,32 +21,39 @@ You can find the customer portal here: [https://support.localstack.cloud/portal] 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. +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. +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" >}} +

+{{< 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. +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. +- **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.). +- **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 index be68d3baa9..59855f76df 100644 --- a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md +++ b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md @@ -8,7 +8,8 @@ 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. +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 @@ -90,7 +91,6 @@ LocalStackList contains a list of LocalStack | `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 @@ -115,7 +115,6 @@ _Appears in:_ | `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 From 8c1c10aba42b318381e3c548fb0875b6ea10bdf6 Mon Sep 17 00:00:00 2001 From: Harsh Mishra Date: Fri, 26 Jul 2024 16:15:13 +0530 Subject: [PATCH 10/12] Update content/en/user-guide/localstack-enterprise/k8s-operator/index.md Co-authored-by: Waldemar Hummer --- .../en/user-guide/localstack-enterprise/k8s-operator/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md index 59855f76df..e723defa3f 100644 --- a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md +++ b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md @@ -33,7 +33,7 @@ spec: debug: trace authToken: "" # Set your LocalStack auth token here - autoLoadPods: [""] # Set your Cloud Pods to automatically load them here + autoLoadPods: [""] # Set your Cloud Pods to automatically load them here (optional) dnsProvider: coredns dnsConfigName: coredns From 1edec270e588d0a1fc27e995a4e84a818db757fc Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Fri, 26 Jul 2024 16:20:20 +0530 Subject: [PATCH 11/12] fix suggestion --- .../en/user-guide/localstack-enterprise/k8s-operator/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md index e723defa3f..423c55f897 100644 --- a/content/en/user-guide/localstack-enterprise/k8s-operator/index.md +++ b/content/en/user-guide/localstack-enterprise/k8s-operator/index.md @@ -20,7 +20,7 @@ $ kubectl apply -f https://raw.githubusercontent.com/localstack/localstack-k8s-o $ kubectl apply -f https://raw.githubusercontent.com/localstack/localstack-k8s-operator/v0.2.0/release/controller.yaml {{< / command >}} -You can then deploy a LocalStack in the following manner: +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 From 5f7ea4470372f796e0bfaa36a51fe7dc7724aceb Mon Sep 17 00:00:00 2001 From: HarshCasper Date: Fri, 26 Jul 2024 16:46:12 +0530 Subject: [PATCH 12/12] add a why use enterprise image section --- .../localstack-enterprise/enterprise-image/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/content/en/user-guide/localstack-enterprise/enterprise-image/index.md b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md index 32e7af3d59..364be15cef 100644 --- a/content/en/user-guide/localstack-enterprise/enterprise-image/index.md +++ b/content/en/user-guide/localstack-enterprise/enterprise-image/index.md @@ -15,6 +15,13 @@ This offline functionality is enabled by: - 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.