CORTEX Documentation

Deployment documentation for the Collaborative Organization for Resource and Trust Exchange (CORTEX) Helm chart.

Installation

$ helm install cortex ./charts/external-ndcp --values my-values.yaml

Several values are required and have no defaults — the chart fails to render if they are unset.

Run helm lint charts/external-ndcp to list them.

Acronyms

Acronym	Full form
AA	Attribute Authority
CMP	Collaboration Management Platform
DS	Discovery Service
FG	Federation Gateway
SP	Service Provider
IdP	Identity Provider
VRO	Virtual Research Organisation

Chart reference

The table below is generated at build time from charts/external-ndcp/Chart.yaml and values.yaml by sphinx-helm. Parameter descriptions come from same-line comments in values.yaml.

Cortex

A Helm chart for deploying the Collaborative Organization for Resource and Trust Exchange (CORTEX) on Kubernetes.

Configuration

The following table lists the configurable parameters of the Cortex chart and example values.

Parameter	Description	Example
AA.image	Attribute authority container image	"zot.cluster.ibrst.org/rdct/attribute-authority:latest"
AA.test.enable	Optional ldap functionality test; deploys a pod that continuously queries the attribute authority	false
FG.satosaImage	SATOSA container image	"satosa:8.5.1"
FG.stateEncryptionKey	The key to be used for state encryption.	"CHANGE_MEcsUEpy"
FG.userIdHashSalt	Salt used to hash the persistent user identifier	"CHANGE_ME4XUeD2X"
FG.proxyHostname	FQDN of the base url	"proxy.cortex.ug"
FG.proxyBaseUrl	base url of the proxy with ‘https://’	"https://proxy.cortex.ug"
FG.certIssuer		"letsencrypt-production"
FG.org.name		"Collaborative Organization LLC."
FG.org.displayName		"CORTEX"
FG.org.url		"http://www.cortex.ug/"
FG.samlScope		"cortex.ug"
FG.supportEmail		"support@cortex.ug"
FG.adminEmail		"admin@cortex.ug"
FG.staticAttributes.organisation		"Collaborative Organization LLC."
FG.staticAttributes.schacHomeOrg		"cortex.ug"
FG.staticAttributes.orgName		"Collaborative Organization LLC."
FG.staticAttributes.noreduAcronym		"EO"
FG.staticAttributes.countryCode		"UG"
FG.staticAttributes.countryName		"Uganda"
DS.httpdImage	Apache httpd image built from discovery-service/Dockerfile.httpd	"zot.cluster.ibrst.org/wayf/httpd:2.4.67"
DS.shibdImage		"i2incommon/shibboleth_sp:3.5.2_05242026_rocky9_multiarch"
DS.hostname	FQDN for the discovery service	"wayf.cortex.ug"
DS.spEntityId	Service Provider entity ID	"https://wayf.cortex.ug/"
DS.certIssuer		"letsencrypt-production"
CMP.image	COmanage Registry container image	"i2incommon/comanage-registry-pe:5.2.0-rocky10.1"
CMP.databasePassword	PostgreSQL registry user password	""
CMP.emailAccountPassword	SMTP account password	""
CMP.securitySalt	COmanage Registry security salt	"CHANGE_ME4XUeD2X"
CMP.hostname		"registry.cortex.ug"
CMP.spEntityId	Service Provider entity ID	"https://registry.cortex.ug/"
CMP.idpEntityId	SATOSA IdP entity ID	"https://proxy.cortex.ug/idp"
CMP.certIssuer		"letsencrypt-production"
CMP.debug		"1"
CMP.env		"dev"
CMP.userToken		"ctx"
CMP.urlPath		"registry"
CMP.enablePlugins		"ServicesWidget"
CMP.admin.givenName	Given Name of initial platform administrator	"Patrick"
CMP.admin.familyName	Family Name of initial platform administrator	"Mukasa"
CMP.admin.username	Username of initial platform administrator	"pmukasa@renu.ac.ug"
CMP.database.name		"registry"
CMP.database.user		"registry_user"
CMP.database.host	CNPG read-write service for the cmp-db cluster	"cmp-db-rw"
CMP.database.port		"5432"
CMP.database.storageSize		"5Gi"
CMP.email.fromEmail		"noreply@cortex.ug"
CMP.email.fromName		"COmanage Registry"
CMP.email.transport		"Smtp"
CMP.email.host		"smtp.cortex.ug"
CMP.email.port		"587"
CMP.email.tls		"true"
CMP.email.account		"noreply@cortex.ug"
DOCS.image	nginx image with the built Sphinx site (config/docs/Dockerfile)	"zot.cluster.ibrst.org/rdct/cortex-docs:latest"
DOCS.hostname	FQDN for the documentation site	"docs.cortex.ug"
DOCS.certIssuer		"letsencrypt-production"

---

Documentation generated by sphinx-helm.