README.md

portal

Formance Portal

Homepage: https://formance.com

Maintainers

Name	Email	Url
Formance Team	[email protected]

Source Code

• https://github.com/formancehq/platform-ui

Requirements

Kubernetes: >=1.14.0-0

Repository	Name	Version
file://../core	core	v1.0.0-beta.9

Values

Global AWS configuration

Key	Type	Default	Description
global.aws.elb	bool	false	Enable AWS ELB
aws	object	{"targetGroups":{"http":{"ipAddressType":"ipv4","serviceRef":{"name":"{{ include \"core.fullname\" $ }}","port":"{{ .Values.service.ports.http.port }}"},"targetGroupARN":"","targetType":"ip"}}}	AWS Portal target groups

Global configuration

Key	Type	Default	Description
global.debug	bool	false	Enable debug mode
global.monitoring.batch	bool	false	Enable otel batching
global.monitoring.traces.enabled	bool	false	Enable otel tracing
global.monitoring.traces.endpoint	string	""	Endpoint
global.monitoring.traces.exporter	string	"otlp"	Exporter
global.monitoring.traces.insecure	bool	true	Insecure
global.monitoring.traces.mode	string	"grpc"	Mode
global.monitoring.traces.port	int	4317	Port
global.platform.console.host	string	"console.{{ .Values.global.serviceHost }}"	is the host for the console
global.platform.console.scheme	string	"https"	is the scheme for the console
global.platform.cookie.encryptionKey	string	"changeMe00"	is used to encrypt a cookie that share authentication between platform services (console, portal, ...),is used to store the current state organizationId-stackId
global.platform.cookie.existingSecret	string	""	is the name of the secret
global.platform.cookie.secretKeys	object	{"encryptionKey":""}	is the key contained within the secret
global.platform.membership.host	string	"membership.{{ .Values.global.serviceHost }}"	is the host for the membership
global.platform.membership.oauthClient.existingSecret	string	""	is the name of the secret
global.platform.membership.oauthClient.id	string	"platform"	is the id of the client
global.platform.membership.oauthClient.secret	string	"changeMe1"	is the secret of the client
global.platform.membership.oauthClient.secretKeys	object	{"secret":""}	is the key contained within the secret
global.platform.membership.scheme	string	"https"	is the scheme for the membership
global.platform.portal.host	string	"portal.{{ .Values.global.serviceHost }}"	is the host for the portal
global.platform.portal.scheme	string	"https"	is the scheme for the portal
global.serviceHost	string	""	is the base domain for portal and console

Other Values

Key	Type	Default	Description
affinity	object	{}	Portal affinity
autoscaling.enabled	bool	false
autoscaling.maxReplicas	int	100
autoscaling.minReplicas	int	1
autoscaling.targetCPUUtilizationPercentage	int	80
config.additionalEnv	list	[]	Additional environment variables
config.cookie.existingSecret	string	""	Cookie existing secret
config.cookie.secret	string	"changeMe2"	Cookie secret
config.cookie.secretKeys	object	{"secret":""}	Cookie secret key
config.environment	string	"production"	Portal environment
config.featuresDisabled[0]	string	"console_v3_beta"
image.pullPolicy	string	"IfNotPresent"	image pull policy
image.repository	string	"ghcr.io/formancehq/portal"	image repository
image.tag	string	""	image tag
imagePullSecrets	list	[]
ingress.annotations	object	{}	ingress annotations
ingress.className	string	""	ingress class name
ingress.enabled	bool	true	ingress enabled
ingress.hosts[0]	object	{"host":"{{ tpl .Values.global.platform.portal.host $ }}","paths":[{"path":"/","pathType":"Prefix"}]}	ingress host
ingress.hosts[0].paths[0].path	string	"/"	ingress path
ingress.hosts[0].paths[0].pathType	string	"Prefix"	ingress path type
ingress.tls	list	[]	ingress tls
livenessProbe	object	{}	Portal liveness probe
nodeSelector	object	{}	Portal node selector
podDisruptionBudget.enabled	bool	false	Enable pod disruption budget
podDisruptionBudget.maxUnavailable	int	0	Maximum unavailable pods
podDisruptionBudget.minAvailable	int	1	Minimum available pods
podSecurityContext	object	{}	Pod Security Context
readinessProbe	object	{}	Portal readiness probe
replicas	int	1	Number of replicas
resources	object	{}	Portal resources
securityContext	object	{}	Container Security Context
service.annotations	object	{}	service annotations
service.clusterIP	string	""	service cluster IP
service.ports.http	object	{"port":3000}	service http port
service.type	string	"ClusterIP"	service type
serviceAccount.annotations	object	{}	Service account annotations
serviceAccount.create	bool	true	Service account creation
serviceAccount.name	string	""	Service account name
tolerations	list	[]	Portal tolerations
volumeMounts	list	[]	Portal volume mounts
volumes	list	[]	Portal volumes