Skip to content

Latest commit

 

History

History
406 lines (243 loc) · 4.96 KB

naming-conventions-for-sap-btp-accounts-5302ea4.md

File metadata and controls

406 lines (243 loc) · 4.96 KB

Naming Conventions for SAP BTP Accounts

While naming conventions are specific for each organization and use case, consider the following recommendations and examples.

  • Each Cloud Foundry org, and respectively, each Kyma cluster, belongs to exactly one subaccount. Thus, it's recommended that you derive the org and cluster names from the subaccount name.

  • Because there's no connection between spaces/namespaces in different subaccounts, we recommend giving identical names to the dev, test, and prod versions of projects and spaces/namespaces.

  • To prevent conflicts with special characters, use lower-case letters and hyphens, and avoid spaces or underscores in names. As an exception, subaccount names may use natural language with capitalization and blank spaces.

  • URLs cannot be longer than 63 characters, so use short names for subaccount, subdomain, Cloud Foundry org and spaces, and Kyma cluster and namespaces. For example, use “prod” instead of “production”.

  • There's no need to mention the company in subaccount names, which are always seen in the context of your global account in the SAP BTP cockpit. However, it's recommended to include the company name in the subdomain and Cloud Foundry org name.

  • If you use directories to group your subaccounts, choose descriptive directory names that reflect the desired distinction - for example, by functional area, location, or subsidiary.

Recommendation:

  • Similar name for a subaccount, its subdomain, and its Cloud Foundry org

  • Identical names for related Cloud Foundry spaces across the landscapes (dev, test, prod)

Directory

HR

Sales

IT

Subaccounts

HR Dev

HR Test

HR Prod

Sales Dev

Sales Test

Sales Prod

IT Dev

IT Test

IT Prod

Subdomains

mycompany-hr-dev

mycompany-hr-test

mycompany-hr-prod

mycompany-sales-dev

mycompany-sales-test

mycompany-sales-prod

mycompany-IT-dev

mycompany-IT-test

mycompany-IT-prod

Cloud Foundry Orgs

mycompany-hr-dev

mycompany-hr-test

mycompany-hr-prod

mycompany-sales-dev

mycompany-sales-test

mycompany-sales-prod

mycompany-IT-dev

mycompany-IT-test

mycompany-IT-prod

Spaces

project-portal

activity-recording

project-portal

activity-recording

project-portal

activity-recording

customer-acquisition

sales-support

customer-acquisition

sales-support

customer-acquisition

sales-support

it-support

central-service

it-support

central-service

it-support

central-service

Recommendation:

  • Similar name for a subaccount, its subdomain, and its Kyma cluster

  • Identical names for related Kyma namespaces across the landscapes (dev+test and prod)

Subaccounts

Dev Test

Prod

Subdomains

mycompany-dev-test

mycompany-prod

Kyma Clusters

dev-test

prod

Namespaces

hr-dev

hr-test

sales-dev

sales-test

it-dev

it-test

hr

sales

it