groups:
  - id: cloud
    prefix: cloud
    type: resource
    brief: >
      A cloud environment (e.g. GCP, Azure, AWS)
    attributes:
      - id: provider
        type:
          allow_custom_values: true
          members:
            - id: 'alibaba_cloud'
              value: 'alibaba_cloud'
              brief: 'Alibaba Cloud'
            - id: 'aws'
              value: 'aws'
              brief: 'Amazon Web Services'
            - id: 'azure'
              value: 'azure'
              brief: 'Microsoft Azure'
            - id: 'gcp'
              value: 'gcp'
              brief: 'Google Cloud Platform'
            - id: 'heroku'
              value: 'heroku'
              brief: 'Heroku Platform as a Service'
            - id: 'ibm_cloud'
              value: 'ibm_cloud'
              brief: 'IBM Cloud'
            - id: 'tencent_cloud'
              value: 'tencent_cloud'
              brief: 'Tencent Cloud'

        brief: >
          Name of the cloud provider.
      - id: account.id
        type: string
        brief: >
          The cloud account ID the resource is assigned to.
        examples: ['111111111111', 'opentelemetry']
      - id: region
        type: string
        brief: >
          The geographical region the resource is running.
        note: >
          Refer to your provider's docs to see the available regions, for example
          [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm),
          [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/),
          [Azure regions](https://azure.microsoft.com/en-us/global-infrastructure/geographies/),
          [Google Cloud regions](https://cloud.google.com/about/locations),
          or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091).
        examples: ['us-central1', 'us-east-1']
      - id: availability_zone
        type: string
        brief: >
          Cloud regions often have multiple, isolated locations known as zones
          to increase availability. Availability zone represents the
          zone where the resource is running.
        note: >
          Availability zones are called "zones" on Alibaba Cloud and Google Cloud.
        examples: ['us-east-1c']
      - id: platform
        type:
          allow_custom_values: true
          members:
            - id: alibaba_cloud_ecs
              value: 'alibaba_cloud_ecs'
              brief: Alibaba Cloud Elastic Compute Service
            - id: alibaba_cloud_fc
              value: 'alibaba_cloud_fc'
              brief: Alibaba Cloud Function Compute
            - id: alibaba_cloud_openshift
              value: 'alibaba_cloud_openshift'
              brief: Red Hat OpenShift on Alibaba Cloud
            - id: aws_ec2
              value: 'aws_ec2'
              brief: AWS Elastic Compute Cloud
            - id: aws_ecs
              value: 'aws_ecs'
              brief: AWS Elastic Container Service
            - id: aws_eks
              value: 'aws_eks'
              brief: AWS Elastic Kubernetes Service
            - id: aws_lambda
              value: 'aws_lambda'
              brief: AWS Lambda
            - id: aws_elastic_beanstalk
              value: 'aws_elastic_beanstalk'
              brief: AWS Elastic Beanstalk
            - id: aws_app_runner
              value: 'aws_app_runner'
              brief: AWS App Runner
            - id: aws_openshift
              value: 'aws_openshift'
              brief: Red Hat OpenShift on AWS (ROSA)
            - id: azure_vm
              value: 'azure_vm'
              brief: Azure Virtual Machines
            - id: azure_container_instances
              value: 'azure_container_instances'
              brief: Azure Container Instances
            - id: azure_aks
              value: 'azure_aks'
              brief: Azure Kubernetes Service
            - id: azure_functions
              value: 'azure_functions'
              brief: Azure Functions
            - id: azure_app_service
              value: 'azure_app_service'
              brief: Azure App Service
            - id: azure_openshift
              value: 'azure_openshift'
              brief: Azure Red Hat OpenShift
            - id: gcp_compute_engine
              value: 'gcp_compute_engine'
              brief: Google Cloud Compute Engine (GCE)
            - id: gcp_cloud_run
              value: 'gcp_cloud_run'
              brief: Google Cloud Run
            - id: gcp_kubernetes_engine
              value: 'gcp_kubernetes_engine'
              brief: Google Cloud Kubernetes Engine (GKE)
            - id: gcp_cloud_functions
              value: 'gcp_cloud_functions'
              brief: Google Cloud Functions (GCF)
            - id: gcp_app_engine
              value: 'gcp_app_engine'
              brief: Google Cloud App Engine (GAE)
            - id: gcp_openshift
              value: 'gcp_openshift'
              brief: Red Hat OpenShift on Google Cloud
            - id: ibm_cloud_openshift
              value: 'ibm_cloud_openshift'
              brief: Red Hat OpenShift on IBM Cloud
            - id: tencent_cloud_cvm
              value: 'tencent_cloud_cvm'
              brief: Tencent Cloud Cloud Virtual Machine (CVM)
            - id: tencent_cloud_eks
              value: 'tencent_cloud_eks'
              brief: Tencent Cloud Elastic Kubernetes Service (EKS)
            - id: tencent_cloud_scf
              value: 'tencent_cloud_scf'
              brief: Tencent Cloud Serverless Cloud Function (SCF)
        brief: >
          The cloud platform in use.
        note: >
          The prefix of the service SHOULD match the one specified in `cloud.provider`.