Deploy Account Management User Interface
note
Account Management API is now deprecated and we recommend that you use Account Management functionality built into Elastic Path Commerce 8.2 and later.
Pre-requisites
- Ensure that all requirements described in the Requirements section are met
- Ensure that you have access to the machine with yarn and npm installed on it
- Ensure that you have access to the
account-management-1.0.0.zip
file in the Elastic Path public Nexus repository - Ensure that the Keycloak initialization is complete and the access details and
client id
are available
Procedure
- Extract the files in the
account-management-1.0.0.zip
file- The zip file should extract its contents including the folder
account-management-app
, which contains the code used in this step
- The zip file should extract its contents including the folder
- Build the docker image (using
account-management-app/docker/Dockerfile
) on your local machine- You will need to be in the parent directory when building and the following command can be used:
cd account-management-1.0.0/account-management-app/
docker build -f ./docker/Dockerfile .
- Push the Docker image to Amazon ECR (Elastic Container Registry)
- Deploy the Docker image in Amazon ECS (Elastic Container Service) with following environment variables
- Create and configure a new Amazon ELB (Elastic Load Balancer) with the Amazon ECS service and appropriate SSL certificates
Docker image environment variables
Parameter | Value |
---|---|
INSTANCE_URL | The Account Management user interface URL |
KEYCLOAK_LOGIN_URL | The Keycloak URL to which the storefront redirects when you login. For example, https://<KEYCLOAKURL>/auth/realms/<REALM ID>/protocol/openid-connect/auth |
KEYCLOAK_LOGOUT_URL | The Keycloak URL to which the storefront redirects when you logout. For example, https://<KEYCLOAKURL>/auth/realms/<REALM ID>/protocol/openid-connect/logout |
KEYCLOAK_CLIENT_ID | eam |
COMMERCE_MANAGER_URL | The URL for the Commerce Manager instance |
ADMIN_API_URL | The URL for the Account Management API Service. For example: https://<ACCOUNT-MANAGEMENT-API>/ |
Validate User Interface Deployment
Use this procedure to verify that the Elastic Path Account Management service deployment is complete and successful in AWS (Amazon Web Services).
- Go to the Account Management user interface url
- The system redirects you to the Keycloak login page
- Log in to the system as the seller administrator account you created
- The system redirects you back to the Account Management user interface