Skip to main content

Deploy with an agent

Copy agent prompt

Before you start

Connect your AWS account using the Spring Winter quickstart. You need postgreSQL and a canonical HTTPS hostname. Check the upstream deployment instructions and pin a release before you deploy. Source repository.

Create and connect the database

  1. Create a private SQL database with PostgreSQL. If you already have a database for this deployment, verify that the engine and version match the pinned app release. Wait for the database to be ready.
  2. Open Connect on the database. Use the writer endpoint, port, database name and application credentials. Create the application database and role if needed. Confirm that the application and migration process can reach the private writer.
  3. Set KC_DB=postgres, KC_DB_URL, KC_DB_USERNAME and KC_DB_PASSWORD. Keep the writer private and configure database TLS for your deployment. Put secret values in runtime configuration or the migration process’s secret store.
  4. Start Keycloak in production mode and let it initialize the schema. Wait for readiness before creating realms.

Configure the deployment

  1. Select a Spring Winter project in the AWS Region you want to use. Use a web server for the HTTP app and configure dependencies before you start it.
  2. Use quay.io/keycloak/keycloak with the production start command and PostgreSQL settings.
  3. For load balancer TLS termination configure KC_HTTP_ENABLED, KC_PROXY_HEADERS and KC_HOSTNAME for your topology.
  4. Use the release’s bootstrap admin settings once.
  5. Keycloak may serve readiness on a separate management port.
  6. Verify that your Spring Winter health check uses a supported path on the configured target port.
When you run the HTTP app on Spring Winter, set a health path that returns HTTP 200 without signing in. Use Runtime variables for runtime configuration. Task storage is temporary. Verify that every file you need after replacement goes to durable storage.

Verify the deployment

Check the deployment in History if you created Spring Winter compute. Wait for the workflow to succeed, then test the application over HTTPS. Create a test realm and client. Verify issuer discovery, login redirects and token issuance through the public hostname.