Quick Start
This guide walks you through deploying Conncentric for the first time.
Before You Start
Make sure you have the tools listed in Prerequisites installed, and that you have:
- A running Kubernetes cluster
- A PostgreSQL database provisioned and accessible from the cluster
- The Conncentric Helm chart (from the repo or provided by Connamara)
Step 1: Create a Namespace
kubectl create namespace conncentric
Step 2: Create a Database Credentials Secret
kubectl create secret generic conncentric-db-credentials \
--from-literal=username=conncentric \
--from-literal=password=your-db-password \
-n conncentric
Step 3: Create a Values File
Create a values.yaml file with your environment settings:
database:
host: "your-postgres-host"
port: 5432
name: "conncentric"
auth:
existingSecret: "conncentric-db-credentials"
portal:
auth:
provider: "external"
authority: "https://your-idp.example.com/"
clientId: "your-client-id"
scope: "openid profile email"
ingress:
enabled: true
host: "conncentric.example.com"
See Helm Reference for the full list of options.
Step 4: Install
helm install conncentric ./deployment/charts/conncentric \
-n conncentric \
-f values.yaml
Step 5: Verify
Check that all pods are running:
kubectl get pods -n conncentric
You should see pods for the Orchestrator, one or more Adapter pods, and the Portal, all in Running state.
Step 6: Open the Portal
Navigate to the hostname you configured in your Ingress (e.g., https://conncentric.example.com).
Log in using your identity provider credentials. See Authentication Configuration for provider-specific setup.
Next Steps
- See what's included: explore the pre-built adapters and run the built-in full-loop test
- Create your first adapter: set up your first connection
- Extend with custom bundles: add your own configurations, plugins, and artifacts