NocoDB
This module deploys an NocoDB instance to the Kubernetes cluster.
Providers
The following providers are needed by this module:
-
aws (5.80.0)
-
helm (2.12.1)
-
kubectl (2.1.3)
-
kubernetes (2.34.0)
-
pf (0.0.7)
-
random (3.6.3)
-
vault (4.5.0)
Required Inputs
The following input variables are required:
domain
Description: The domain from which NocoDB will serve traffic
Type: string
superuser_email
Description: The email address to use for the root NocoDB administrator. Warning: must be changed manually once applied.
Type: string
Optional Inputs
The following input variables are optional (have default values):
attachment_max_allowed
Description: The maximum number of attachments allowed per cell.
Type: number
Default: 10
attachment_max_size_mb
Description: The maximum file size allowed for attachments in MB.
Type: number
Default: 20
auth_expires_hours
Description: How many hours that users' authentication is valid before expiring and requiring a new login.
Type: number
Default: 10
aws_iam_ip_allow_list
Description: A list of IPs that can use the service account token to authenticate with AWS API
Type: list(string)
Default: []
cdn_mode_enabled
Description: Whether to enable CDN mode for the Vault ingress
Type: bool
Default: true
db_recovery_directory
Description: The name of the directory in the backup bucket that contains the PostgreSQL backups and WAL archives
Type: string
Default: null
db_recovery_mode_enabled
Description: Whether to enable recovery mode for the PostgreSQL database
Type: bool
Default: false
db_recovery_target_time
Description: If provided, will recover the PostgreSQL database to the indicated target time in RFC 3339 format rather than to the latest data.
Type: string
Default: null
ingress_enabled
Description: Whether to enable ingress to the NocoDB server
Type: bool
Default: false
log_level
Description: The log level for the NocoDB pods
Type: string
Default: "debug"
monitoring_enabled
Description: Whether to add active monitoring to the deployed systems
Type: bool
Default: false
namespace
Description: Kubernetes namespace to deploy the resources into
Type: string
Default: "nocodb"
nocodb_version
Description: The version of NocoDB to use
Type: string
Default: "0.258.10"
panfactum_scheduler_enabled
Description: Whether to use the Panfactum pod scheduler with enhanced bin-packing
Type: bool
Default: true
pull_through_cache_enabled
Description: Whether to use the ECR pull through cache for the deployed images
Type: bool
Default: true
secure_attachments_enabled
Description: Enables access to attachments only through pre-signed URLs.
Type: bool
Default: true
sla_target
Description: The Panfactum SLA level for the module deployment. 1 = lowest uptime (99.9%), lowest cost -- 3 = highest uptime (99.999%), highest Cost
Type: number
Default: 3
vpa_enabled
Description: Whether the VPA resources should be enabled
Type: bool
Default: true
Outputs
The following outputs are exported:
db_admin_role
Description: n/a
db_reader_role
Description: n/a
db_recovery_directory
Description: The name of the directory in the backup bucket that contains the PostgreSQL backups and WAL archives
db_superuser_role
Description: n/a
domain
Description: n/a
namespace
Description: The name of the namespace where NocoDB will be deployed.
redis_admin_role
Description: n/a
redis_reader_role
Description: n/a
redis_superuser_role
Description: n/a
s3_bucket
Description: The name of the S3 bucket where NocoDB will store attachments and other assets.
superuser_email
Description: The email for the superuser user.
superuser_password
Description: The password for the superuser user.
Usage
No notes