Skip to main content

Onboarding

Onboarding is the process of provisioning and deploying new Deepdesk accounts. This section covers both the general workflow for administrators and the technical implementation details for developers.

Components Overview

The onboarding process is managed through two main components:

Onboarding Service

The Onboarding Service maintains a global registry of all Deepdesk accounts. This service:

  • Stores global account configuration (e.g., which project an account should be deployed in)
  • Tracks account status (active/inactive)
  • Is accessible only to internal Deepdesk staff
  • Runs outside of individual account production clusters

Admin Service

The Admin Service is deployed for each individual account and contains:

  • Account-specific configuration
  • Credentials needed to operate internal services (Backend and Engine)
  • Integration settings for the CX Platform
  • Runs within an isolated, account-specific namespace in a regional cluster

Onboarding Process Overview

The onboarding process involves several steps:

  1. Account Creation: A Deepdesk staff member creates a new account in the Onboarding service
  2. Infrastructure Provisioning: Automated systems provision the necessary infrastructure (namespaces, secrets, etc.)
  3. Service Deployment: Core services and machine learning pipelines are deployed to the account's namespace via Helm charts
  4. Configuration: Account-specific configuration is set up in the Admin service
  5. Final Deployment: The account is activated and ready for use

The process includes both manual steps (performed by Deepdesk staff) and automated workflows that handle the technical provisioning and deployment.

Documentation Structure

This section is organized into:

  • User Guide: Step-by-step instructions about the onboarding process, components, and workflow
  • Developer Guide: Technical details about services, deployment architecture, sequence diagrams, and CI/CD integration