Deploy core services

Deploy core services to initialise the system and enable its key functionalities and endpoints.

About this task

Start all required core services using the deployment script, then validate that they are running correctly by checking their status, reviewing logs if needed, and confirming access through the configured endpoints.
Remember: If you are using zCX, perform all deployment-related actions, including deploying core services, within the docker-compose-cli container.

Procedure

  1. Deploy all core services:
    ./deploy.sh up --profile core
    
    The deployment script starts the required Docker Compose services and automatically generates the necessary certificates.
  2. Verify that the deployment completed successfully:
    1. Check the status of all services:
      ./deploy.sh status
      
    2. Ensure that all core services are running.
      If any service is not running, check the service logs:
      ./deploy.sh logs <service-name> -f
      
      For example:
      ./deploy.sh logs nginx -f
      
      You can also review all Docker containers:
      docker ps -a
      
    Note: If you make any changes to core services after the initial setup of agents and core services, you must redeploy the foundational agents as well using the following commands:
    ./deploy.sh down --profile core --profile foundational-agents
    ./deploy.sh up --profile core --profile foundational-agents
  3. Access the core services.
    After successfully deploying the core services, access them to interact with the system, verify that it is functioning as expected, and utilize key features such as data ingestion, search, and health monitoring through the available endpoints.
    • Access the system through the NGINX reverse proxy:
      https://<host>:8443/
      
    Replace <host> with the deployment host name, fully qualified domain name (FQDN), or IP address.
    Common endpoints:
    Service Endpoint
    Content ingestion UI https://<host>:8443/
    Client ingestion API https://<host>:8443/client-ingestion/
    OpenSearch Wrapper https://<host>:8443/search/
    NGINX Health Check https://<host>:8443/nginx-health