Naming

By Anna V. January 15, 2025. Revised. Version: 0.1.03

This section details the naming conventions used for specific types of resources within the k8or Orbit application. Consistent naming is essential for easy identification, management, and automation of these resources.

Naming Convention Example

• DynamoDB Tables: DynamoDB table names follow the format: [Application/Context]-[Descriptive Name]-[Suffix]-[Environment]-[Cloud Provider].

  • Application/Context: A short identifier indicating the application or context to which the table belongs (e.g., user, image, k8or).

  • Descriptive Name: A descriptive name for the table, using hyphens to separate words (e.g., user-data, app-image-metadata).

  • Suffix: A suffix indicating the resource type - -tbl for table.

  • Environment: The k8or environment, such as -k8d for development, -k8t for testing, -k8s for staging, -k8p for production.

  • Cloud Provider: The cloud provider where the table is created, -aws for AWS.

  • Examples:

    • user-data-1612-tbl-k8d-aws: A table storing user data.

    • app-image-metadata-1615-tbl-k8d-aws: A table storing metadata about application images.

    • user-event-log-1621-tbl-k8d-aws: A table storing user event logs.

    • portal-upload-static-data-1627-tbl-k8d-aws: A table storing static data for image uploads.

• S3 Buckets: S3 bucket names follow the format: [Application/Context]-[Descriptive Name]-[Suffix]-[Environment]-[Cloud Provider].

  • Application/Context: A short identifier indicating the application or context to which the bucket belongs (e.g., user, image, k8or).

  • Descriptive Name: A descriptive name for the bucket, using hyphens to separate words (e.g., user-data, app-image-metadata).

  • Suffix: A suffix indicating the resource type - -bkt for bucket.

  • Environment: The k8or environment - -k8d for development, -k8t for testing, -k8s for staging, -k8p for production.

  • Cloud Provider: The cloud provider where the table is created, -aws for AWS.

  • Examples:

    • temporary-app-image-1203-bkt-k8d-aws: A temporary bucket for storing images before validation.

    • app-image-1206-bkt-k8d-aws: A permanent bucket for storing validated application images.

    • k8or-backup-bkt-prod-k8d-aws: A backup bucket for the k8or portal in production.

• MySQL Databases: MySQL database names follow the format: [Application/Context]_[Descriptive Name]_[Suffix]_[Environment]_[Cloud Provider].

  • Application/Context: A short identifier indicating the application or context to which the database belongs (e.g., app, k8or).

  • Descriptive Name: A descriptive name for the database, using underscores to separate words (e.g., image_mql).

  • Suffix: A suffix indicating the resource type - -dtb for database.

  • Environment: The k8or environment, such as -k8d for development, -k8t for testing, -k8s for staging, -k8p for production.

  • Cloud Provider: The cloud provider where the table is created, -aws for AWS.

  • Examples:

    • app_image_mql_2003_dtb_k8d_aws: A MySQL database for application image data in development.

    • app_image_mql_2003_dtb_k8p_aws: A MySQL database for application image data in production.