Skip to content

chore: document constant usage #2123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shikanime merged 1 commit into from
Apr 30, 2026
Merged

chore: document constant usage #2123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apps/server-nestjs/src/modules/argocd/argocd.constant.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
// Path for console admin group
export const CONSOLE_ADMIN_GROUP_PATH = '/console/admin'
export const PLATFORM_ADMIN_GROUP_PATH = '/console/admin'
export const PLATFORM_READONLY_GROUP_PATH = '/console/readonly'
export const PLATFORM_SECURITY_GROUP_PATH = '/console/security'

// Suffix for project group path
export const PROJECT_ADMIN_GROUP_PATH_SUFFIX = '/console/admin'
export const PROJECT_DEVOPS_GROUP_PATH_SUFFIX = '/console/devops'
export const PROJECT_DEVELOPER_GROUP_PATH_SUFFIX = '/console/developer'
Expand Down
6 changes: 6 additions & 0 deletions apps/server-nestjs/src/modules/gitlab/gitlab.constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
// ArgoCD infrastructure automation
export const INFRA_GROUP_NAME = 'Infra'
export const INFRA_GROUP_PATH = 'infra'
export const INFRA_APPS_REPO_NAME = 'infra-apps'
export const MIRROR_REPO_NAME = 'mirror'

// Managed resources sentinel
export const TOPIC_PLUGIN_MANAGED = 'plugin-managed'
export const TOKEN_DESCRIPTION = 'mirroring-from-external-repo'

// Default group paths for console roles
export const DEFAULT_ADMIN_GROUP_PATH = '/console/admin'
export const DEFAULT_AUDITOR_GROUP_PATH = '/console/readonly'
export const DEFAULT_PROJECT_MAINTAINER_GROUP_PATH_SUFFIX = '/console/admin'
export const DEFAULT_PROJECT_DEVELOPER_GROUP_PATH_SUFFIX = '/console/developer,/console/devops'
export const DEFAULT_PROJECT_REPORTER_GROUP_PATH_SUFFIX = '/console/readonly'

// Plugin configuration keys
export const ADMIN_GROUP_PATH_PLUGIN_KEY = 'adminGroupPath'
export const AUDITOR_GROUP_PATH_PLUGIN_KEY = 'auditorGroupPath'
export const PROJECT_REPORTER_GROUP_PATH_SUFFIX_PLUGIN_KEY = 'projectReporterGroupPathSuffix'
export const PROJECT_DEVELOPER_GROUP_PATH_SUFFIX_PLUGIN_KEY = 'projectDeveloperGroupPathSuffix'
export const PROJECT_MAINTAINER_GROUP_PATH_SUFFIX_PLUGIN_KEY = 'projectMaintainerGroupPathSuffix'
export const PURGE_PLUGIN_KEY = 'purge'

// Custom attribute keys used in GitLab groups
export const GROUP_ROOT_CUSTOM_ATTRIBUTE_KEY = 'cpn_projects_root_dir'
export const INFRA_GROUP_CUSTOM_ATTRIBUTE_KEY = 'cpn_infra_group'
export const PROJECT_GROUP_CUSTOM_ATTRIBUTE_KEY = 'cpn_project_slug'
Expand Down
3 changes: 3 additions & 0 deletions apps/server-nestjs/src/modules/keycloak/keycloak.constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Name for the console group for admin and project roles
export const CONSOLE_GROUP_NAME = 'console'

// Maximum number of entities returned in a paginated query
export const GROUPS_PAGINATE_QUERY_MAX = 20
export const SUBGROUPS_PAGINATE_QUERY_MAX = 20
6 changes: 6 additions & 0 deletions apps/server-nestjs/src/modules/vault/vault.constant.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
// Plugin name used to identify the Vault integration
export const VAULT_PLUGIN_NAME = 'vault'

// Platform-level policy names for RBAC
export const PLATFORM_ADMIN_POLICY_NAME = 'platform--admin'
export const PLATFORM_READONLY_POLICY_NAME = 'platform--readonly'
export const PLATFORM_SECURITY_POLICY_NAME = 'platform--security'

// Console group names for user role assignment
export const CONSOLE_ADMIN_GROUP_NAME = 'console-admin'
export const CONSOLE_READONLY_GROUP_NAME = 'console-readonly'
export const CONSOLE_SECURITY_GROUP_NAME = 'console-security'

// Default LDAP/AD group paths for console access
export const DEFAULT_ADMIN_GROUP_PATH = '/console/admin'
export const DEFAULT_AUDITOR_GROUP_PATH = '/console/readonly'
export const DEFAULT_SECURITY_GROUP_PATH = '/console/security'

// Default suffixes for project-scoped group paths
export const DEFAULT_PROJECT_MAINTAINER_GROUP_PATH_SUFFIX = '/console/admin'
export const DEFAULT_PROJECT_DEVELOPER_GROUP_PATH_SUFFIX = '/console/developer'
export const DEFAULT_PROJECT_DEVOPS_GROUP_PATH_SUFFIX = '/console/devops'
export const DEFAULT_PROJECT_REPORTER_GROUP_PATH_SUFFIX = '/console/readonly'
export const DEFAULT_PROJECT_SECURITY_GROUP_PATH_SUFFIX = '/console/security'

// Plugin configuration keys for custom group paths
export const ADMIN_GROUP_PATH_PLUGIN_KEY = 'adminGroupPath'
export const AUDITOR_GROUP_PATH_PLUGIN_KEY = 'auditorGroupPath'
export const SECURITY_GROUP_PATH_PLUGIN_KEY = 'securityGroupPath'
Expand Down
Loading