diff --git a/content/en/user-guide/web-application/accounts/account-settings.png b/content/en/user-guide/web-application/accounts/account-settings.png new file mode 100644 index 0000000000..904bdf89f6 Binary files /dev/null and b/content/en/user-guide/web-application/accounts/account-settings.png differ diff --git a/content/en/user-guide/web-application/accounts/account-signup-form.png b/content/en/user-guide/web-application/accounts/account-signup-form.png new file mode 100644 index 0000000000..959f69ee46 Binary files /dev/null and b/content/en/user-guide/web-application/accounts/account-signup-form.png differ diff --git a/content/en/user-guide/web-application/accounts/account.png b/content/en/user-guide/web-application/accounts/account.png deleted file mode 100644 index 92d4c78f11..0000000000 Binary files a/content/en/user-guide/web-application/accounts/account.png and /dev/null differ diff --git a/content/en/user-guide/web-application/accounts/index.md b/content/en/user-guide/web-application/accounts/index.md index 525f17e6ca..6f168a3546 100644 --- a/content/en/user-guide/web-application/accounts/index.md +++ b/content/en/user-guide/web-application/accounts/index.md @@ -2,22 +2,67 @@ title: "Accounts" weight: 10 description: > - The LocalStack accounts gives users access to the features in the web app like the resource browser, Stack Insight, Cloud pods, extensions and more. + A LocalStack account is required to access features in the Web Application, and to access any of our offerings. --- -A LocalStack account is required to access features in the web app, and to access any of our paid offerings. +## Introduction + +A user account on the LocalStack Web Application is required to access the following features: + +- Advanced AWS services +- Resource Browsers +- Cloud Pods +- Extensions Library +- Stack Insights +- Ephemeral Instances +- IAM Policy Stream +- Chaos Engineering + +To create an Auth Token for your LocalStack account, you need to sign up for an account on the LocalStack Web Application. + +This token is used to authenticate your requests to the LocalStack platform and access the features mentioned above. ## Creating an Account -Visit [**app.localstack.cloud/sign-up**](https://app.localstack.cloud/sign-up) to create a user account for LocalStack. -You can sign up with your email address or one of our supported social identity providers (such as GitHub). +You can either: + +- Sign up with GitHub, or +- Enter your email address and follow the prompts. + +After submitting your email: + +1. Select whether you're working on **commercial** or **personal** projects. +2. Fill in your first and last name. +3. (**Optional**) Add company, job title, and GitHub username. +4. Agree to the terms and conditions to continu +. + +A verification link will be sent to your email. +Once verified, you can log in using your email or GitHub account. + +> Terms: [localstack.cloud/legal/tos](https://www.localstack.cloud/legal/tos) +> Privacy Policy: [localstack.cloud/legal/privacy-policy](https://www.localstack.cloud/legal/privacy-policy) + +Account sign-up form + +## Logging In + +Once your account is activated, log in at [**app.localstack.cloud**](https://app.localstack.cloud) using your selected sign-in method. + +Supported login options: +- GitHub +- SSO (if configured) +- Email-based authentication -The Terms and Conditions can be found at https://www.localstack.cloud/legal/tos and our privacy policy can be found at https://www.localstack.cloud/legal/privacy-policy +## Updating Account Settings -A screenshot of the sign up form +To update your profile or change account settings: -## Updating Account Info and Settings +1. Click your name or organization's name in the top-left corner. +2. Select **Settings** from the dropdown. +3. Navigate to **Profile** to update your name, company, job title, phone number, or GitHub username. -To update your account info, password and settings select the corresponding entry from the sidebar under the 'Account' menu entry. +Account settings in sidebar +

-A screenshot of the 'Account Information' page with the 'Account' section highlighted in the navigation sidebar on the left. +Changes are saved automatically once submitted. diff --git a/content/en/user-guide/web-application/accounts/signup.PNG b/content/en/user-guide/web-application/accounts/signup.PNG deleted file mode 100644 index f15486b9c4..0000000000 Binary files a/content/en/user-guide/web-application/accounts/signup.PNG and /dev/null differ diff --git a/content/en/user-guide/web-application/ci-keys/index.md b/content/en/user-guide/web-application/ci-keys/index.md index f365bf1f36..654a445c07 100644 --- a/content/en/user-guide/web-application/ci-keys/index.md +++ b/content/en/user-guide/web-application/ci-keys/index.md @@ -32,19 +32,3 @@ These keys are linked to specific CI pipelines or projects, rather than individu CI Keys are not meant for individual developers. To grant a developer access to LocalStack and its advanced features, assign a license to them on the [Users & Licenses page](https://app.localstack.cloud/workspace/members). - -{{< callout >}} -We have recently introduced Auth Tokens to replace _developer_ API keys. -However, this change does not affect **CI Keys**, which remain the sole method for activating a LocalStack instance in Continuous Integration (CI) or other automated test environments. -{{< /callout >}} - -## Managing CI keys - -To create a new CI key, input a meaningful name in the provided field and click the 'Generate CI Key' button. -For better management, it's advisable to use a distinct CI key for each project or CI pipeline. -You can manage existing CI keys by renaming, rotating, or deleting them through the options available in the list. - -The top section of the CI page displays the usage of CI tokens for the current period. -Each period lasts one month, and the token count resets at the beginning of a new period. -The dates for the current period are indicated near the usage graph. -While there's no limit to the number of CI keys a workspace can have, all the keys contribute to the same quota. diff --git a/content/en/user-guide/web-application/instance-management/index.md b/content/en/user-guide/web-application/instance-management/index.md index f3382d9b41..5c2efa4b89 100644 --- a/content/en/user-guide/web-application/instance-management/index.md +++ b/content/en/user-guide/web-application/instance-management/index.md @@ -13,9 +13,12 @@ You can access this feature through the [**LocalStack Instances**](https://app.l Instance Management offers these features: +- **Overview**: Shows the stack details of your LocalStack instances. - **Status**: Shows the status of the services running in the LocalStack container. - **Resource Browser**: Lets you view and manage your local AWS resources. - **State**: Allows you to export and import the state of your LocalStack instances. +- **IAM Policy Stream**: Provides a stream of IAM policies corresponding to the AWS API calls. +- **Chaos Engineering**: Allows you to inject failures & simulate outages in your LocalStack instance. - **Extensions**: Provides extra integrations to improve your LocalStack experience. LocalStack Web Application's Instance Management page diff --git a/content/en/user-guide/web-application/instance-management/instance-management.png b/content/en/user-guide/web-application/instance-management/instance-management.png index 0b7705e53d..e4804e29c6 100644 Binary files a/content/en/user-guide/web-application/instance-management/instance-management.png and b/content/en/user-guide/web-application/instance-management/instance-management.png differ diff --git a/content/en/user-guide/web-application/resource-browser/index.md b/content/en/user-guide/web-application/resource-browser/index.md index 098f2b0326..4730e34d0a 100644 --- a/content/en/user-guide/web-application/resource-browser/index.md +++ b/content/en/user-guide/web-application/resource-browser/index.md @@ -10,7 +10,7 @@ description: > The LocalStack Resource Browser allow you to view, manage, and deploy AWS resources locally while building & testing their cloud applications locally. It provides an internal, integrated experience, similar to the AWS Management Console, to manage the ephemeral resources in a LocalStack container on your local machine. -LocalStack Web Application's Resource Browsers outlining various local AWS services +LocalStack Web Application's Resource Browsers outlining various local AWS services The Resource Browser provide an experience similar to the AWS Management Console. However, the Resource Browser is not a replacement for the AWS Management Console and only replicate some of the features of the AWS Management Console. @@ -70,6 +70,7 @@ The Resource Browser supports the following AWS services: | | [Amazon DocumentDB](https://app.localstack.cloud/inst/default/resources/docdb/clusters) | | | [Amazon Neptune](https://app.localstack.cloud/inst/default/resources/neptune/clusters) | | | [Amazon Timestream](https://app.localstack.cloud/inst/default/resources/timestream-write) | +| | [Amazon Redshift](https://app.localstack.cloud/inst/default/resources/redshift/clusters) | | **Analytics** | [Amazon Athena](https://app.localstack.cloud/inst/default/resources/athena/databases) | | | [Amazon Kinesis](https://app.localstack.cloud/inst/default/resources/kinesis) | | | [Amazon MSK (Managed Streaming for Kafka)](https://app.localstack.cloud/inst/default/resources/kafka) | @@ -78,6 +79,7 @@ The Resource Browser supports the following AWS services: | | [Amazon CloudFront](https://app.localstack.cloud/inst/default/resources/cloudfront/distributions) | | | [Amazon OpenSearch Service](https://app.localstack.cloud/inst/default/resources/opensearch/domains) | | **Cloud Financial Management** | [AWS Cost Explorer](https://app.localstack.cloud/inst/default/resources/ce/costcategorydefinitions) | +| **Migration & Transfer** | [Database Migration Service](https://app.localstack.cloud/inst/default/resources/dms/endpoints) | ## Troubleshooting diff --git a/content/en/user-guide/web-application/resource-browser/resource-browser.png b/content/en/user-guide/web-application/resource-browser/resource-browser.png index 09fda02c1e..71d4bb0aaa 100644 Binary files a/content/en/user-guide/web-application/resource-browser/resource-browser.png and b/content/en/user-guide/web-application/resource-browser/resource-browser.png differ diff --git a/content/en/user-guide/web-application/stack-insights/stack-insights-getting-started.png b/content/en/user-guide/web-application/stack-insights/stack-insights-getting-started.png index d1dc853973..917e6af5fa 100644 Binary files a/content/en/user-guide/web-application/stack-insights/stack-insights-getting-started.png and b/content/en/user-guide/web-application/stack-insights/stack-insights-getting-started.png differ diff --git a/content/en/user-guide/web-application/stack-overview/index.md b/content/en/user-guide/web-application/stack-overview/index.md index adfe1100ff..f170304353 100644 --- a/content/en/user-guide/web-application/stack-overview/index.md +++ b/content/en/user-guide/web-application/stack-overview/index.md @@ -12,7 +12,7 @@ The Stack Overview provides a summary of deployed resources, categorized service You can access the Stack Overview in the [LocalStack Web Application](https://app.localstack.cloud/inst/default/overview). Alternatively, go to your LocalStack Instance and click on **Overview** to see a high-level visualization of your locally running cloud app architecture. -Stack Overview +Stack Overview

diff --git a/content/en/user-guide/web-application/stack-overview/stack-overview.png b/content/en/user-guide/web-application/stack-overview/stack-overview.png index 758148b4b6..2545e96865 100644 Binary files a/content/en/user-guide/web-application/stack-overview/stack-overview.png and b/content/en/user-guide/web-application/stack-overview/stack-overview.png differ diff --git a/content/en/user-guide/web-application/users-and-licenses/index.md b/content/en/user-guide/web-application/users-and-licenses/index.md new file mode 100644 index 0000000000..66d67e6a72 --- /dev/null +++ b/content/en/user-guide/web-application/users-and-licenses/index.md @@ -0,0 +1,92 @@ +--- +title: "Users and Licenses" +weight: 30 +description: > + Invite new users and manage a user's license and legacy API key. +aliases: + - /user-guide/web-application/users-and-licenses +--- + +## Introduction + +The **Users & Licenses** page in the LocalStack Web Application allows workspace administrators to manage user memberships, assign licenses, and transition users from legacy API keys to the new license system. + +To access this page: +1. Click on your name in the top-left corner of the dashboard. +2. Go to **Settings** → **Users & Licenses** under the **Administration** section. + +Users & Licenses management screen + +## Managing Users + +### Inviting Users + +To invite someone to your workspace: + +- Go to the **Invite User** section. +- Enter the name and email of the user. +- Check the option to automatically assign a license (optional). +- Click **Invite To Workspace**. + +If the invitee does not have a LocalStack account, they will receive an email to create one. + +The name entered here is only a placeholder until the user completes signup. + +{{< callout >}} +Only workspace admins can invite users and manage license assignments. +{{< /callout >}} + +Invite user form + +### Removing Users + +To remove a user from the workspace: + +- Click on the user entry to expand their details. +- Click **Remove User from Workspace**. + +You can re-invite them anytime. + +### Managing Roles and Permissions + +Click on a user’s entry to view and edit their role. + +- Set them as **Admin** or **Member** +- Configure advanced permissions if available + +## Managing Licenses + +Licenses are part of subscription plans and are shown under the **Licenses** section. + +- To **assign** a license: Use the dropdown next to a user in the members list. +- To **unassign** a license: Click the `x` on the license badge next to the user. +- A license can be reassigned at any time. + +Changes apply immediately and don’t require user action. + +## Migrating from Legacy API Keys + +Previously, access was granted via personal developer API keys. + +### Why move to Auth Tokens? + +- Auth Tokens are more secure and rotate-friendly. +- Admins can manage licenses without the user needing to change configurations. +- Users authenticate once with the token; the license is linked automatically. + +### Migration Process + +1. Go to the **Workspace Members** list. +2. Assign a license to a user. +3. Ask the user to switch their config to use an **Auth Token** (available in the **Auth Tokens** page). +4. Remove the legacy API key once the Auth Token is in use. + +{{< callout >}} +If a user has both a legacy API key and a license, it only counts as **one** active license + +{{< /callout >}} + +### Deprecation Notice + +Legacy API keys are still supported for now, but will be phased out over the coming months. +We recommend migrating to licenses and Auth Tokens as soon as possible. diff --git a/content/en/user-guide/web-application/users-and-licenses/invite-user.png b/content/en/user-guide/web-application/users-and-licenses/invite-user.png new file mode 100644 index 0000000000..4a24a4ba26 Binary files /dev/null and b/content/en/user-guide/web-application/users-and-licenses/invite-user.png differ diff --git a/content/en/user-guide/web-application/users-and-licenses/users-licenses-page.png b/content/en/user-guide/web-application/users-and-licenses/users-licenses-page.png new file mode 100644 index 0000000000..44d295267a Binary files /dev/null and b/content/en/user-guide/web-application/users-and-licenses/users-licenses-page.png differ diff --git a/content/en/user-guide/web-application/users-licences/index.md b/content/en/user-guide/web-application/users-licences/index.md deleted file mode 100644 index d7561b99ae..0000000000 --- a/content/en/user-guide/web-application/users-licences/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "Managing Users and Licenses" -weight: 30 -description: > - Invite new users and manage a user's license and legacy API key. ---- - -Within a workspace, users and their associated licenses are managed on the Users & Licenses page. -This page allows to manage users and assign licenses to them. - -Illustrative screenshot of the LocalStack web app showing the page 'Users & Licenses' - -## Managing Users - -### Inviting Users to the Workspace - -New and existing LocalStack users can be invited to a workspace in the 'Invite Users' section. -To invite a user, provide the user's name and email address. -If the invitee does not have a LocalStack account yet, an invitation to create an account will be sent to the provided email address. -The user's name is used as placeholder for easier managing and will be replaced by the actual username once the account is created. - -{{< callout >}} -Administrators can invite users to a workspace, and can freely assign and unassign licenses or legacy API keys to users. -LocalStack automatically assigns a license to the user who is making the purchase, which can be reassigned again with no restrictions. -{{< /callout >}} - -### Removing Users - -A user can be removed from a workspace by clicking the user entry in the list to show the user's details. -This users detail view also shows the 'Remove User from Workspace' button. -Removed users can be shown by enabling the 'Show Removed' toggle on the top right hand corner of the 'Workspace Members' section. -Removed users can be reinvited into a workspace with the 'Resend Invitation' button. - -### Managing User Permissions - -User permissions can be managed by clicking the user in the list. -This will expand the users detailed settings where a predefined role or advanced permissions can be set. - -## Managing Licenses - -A license is required to use advanced features of LocalStack. -Licenses are contained in subscriptions and plans. -The section 'Licenses' lists the active plan/subscription in the workspace and also shows how many licenses (and legacy API keys) are currently in use. - -To assign a license to a user, find the user entry in the 'Workspace Members' list, and click the 'Assign License' button. -This button will be greyed out (disabled) if there are no licenses left. - -To unassign a user's license, again, find the user in the list and click the 'x' next to the license badge. - -Changes to licenses take effect immediately and require no further action of the user. - -## Moving from legacy API Keys to Licenses - -In the past, access to LocalStack and advanced features was granted to individual developers by providing them with a (now legacy) API key. - -With the recent change, now the recommended way is to assign a 'license' to a user instead. -Instead of using the legacy API key, the user sets up their personal Auth Token to access LocalStack advanced features. -Upon authentication, the the Auth Token is used to identify the user and to retrieve and activate an assigned license. - -The benefits of this new systems are: - -- Auth tokens are longer and more secure (more bits of entropy) -- A user can freely rotate their Auth Token (if needed) without any changes to their license. -- An admin can manage users's licenses, not requiring any configuration change of the user. - Previously users had to manually update their (legacy) API key. - -### Migrating Users to Auth Tokens and Licenses - -To migrate users from legacy API keys, assign a license to them in the 'Workspace Members' list. -The list also shows the legacy API key that is currently assigned to them. -If a user already has a legacy API key assigned, assigning a license to them will not consume an additional license. -A user holding both a legacy API key and a license is only counted once when the number of used licenses is computed. - -If a user uses an API key that was not assigned to them, then it might be necessary to first remove the API key before a license can be assigned. - -Once the license is assigned to the user, and the user set up their system to use the new Auth Token, their legacy API key can be deleted from the workspace. -A user can find their personal Auth Token either in the 'Auth Token' or in the 'Getting Started' section of the web app. - -### Sunsetting legacy API keys - -In this transition period we continue to support legacy API keys. -We will gradually phase them out over the next months, helping customers to smoothly transition over to the new license management. diff --git a/content/en/user-guide/web-application/users-licences/users-licences.png b/content/en/user-guide/web-application/users-licences/users-licences.png deleted file mode 100644 index a62563b800..0000000000 Binary files a/content/en/user-guide/web-application/users-licences/users-licences.png and /dev/null differ diff --git a/content/en/user-guide/web-application/workspace/index.md b/content/en/user-guide/web-application/workspace/index.md new file mode 100644 index 0000000000..fdc2ce904b --- /dev/null +++ b/content/en/user-guide/web-application/workspace/index.md @@ -0,0 +1,44 @@ +--- +title: "Workspace" +weight: 20 +description: > + A Workspace is the base organizational unit in the LocalStack Web Application. +aliases: + - /user-guide/web-application/workspaces +--- + +## Introduction + +In LocalStack, a **Workspace** is the foundational unit for organizing users, resources, and billing. + +It enables collaboration across teams and provides access to shared capabilities. + +## Workspace Features + +These include: + +- **Cloud Pods** : Manage and share your state snapshots. +- **Stack Insights**: Monitor and observe your LocalStack usage. +- **Extensions**: Access the Extensions Library. + +You can find these under the **Workspace** section in the left sidebar. + +User workspace features section in sidebar + +## Workspace Settings + +Workspace settings can be accessed by clicking your or your organization's name in the top-left corner → **Settings** → **Workspace**. + +Here, administrators can configure and manage: + +- Workspace name +- Company account status +- Country and Tax ID +- User and license management +- Authentication tokens +- Subscriptions and billing +- Legacy CI/API keys (if applicable) + +These options are available under the **Administration** section. + +Administration settings for workspace diff --git a/content/en/user-guide/web-application/workspace/workspace-admin-settings.png b/content/en/user-guide/web-application/workspace/workspace-admin-settings.png new file mode 100644 index 0000000000..4db0e5ff63 Binary files /dev/null and b/content/en/user-guide/web-application/workspace/workspace-admin-settings.png differ diff --git a/content/en/user-guide/web-application/workspace/workspace-features.png b/content/en/user-guide/web-application/workspace/workspace-features.png new file mode 100644 index 0000000000..19823b8267 Binary files /dev/null and b/content/en/user-guide/web-application/workspace/workspace-features.png differ diff --git a/content/en/user-guide/web-application/workspaces/index.md b/content/en/user-guide/web-application/workspaces/index.md deleted file mode 100644 index abdff54da1..0000000000 --- a/content/en/user-guide/web-application/workspaces/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Workspaces" -weight: 20 -description: > - A workspace is the base organizational unit in the LocalStack web application. ---- - -In LocalStack, a workspace allows you to collaborate with members of your organization and it encapsulates user and license management, subscriptions and billing, as well as access to shared resources and features like Cloud Pods or Stack Insights. - -A workspace represents the base organizational unit in the web application. -Users can be invited to join a workspace, and an admin can manage their license and permissions inside a workspace. - -A screenshot of the LocalStack web application. The section labeled 'Workspace' in the sidebar on the left is highlighted and shows sub menu entries like 'Workspace Info', 'Auth Token', Users & Licenses', 'Subscriptions'. diff --git a/content/en/user-guide/web-application/workspaces/workspace.png b/content/en/user-guide/web-application/workspaces/workspace.png deleted file mode 100644 index 08c69aab78..0000000000 Binary files a/content/en/user-guide/web-application/workspaces/workspace.png and /dev/null differ