diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index d0efd84320..5084224a74 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -34,6 +34,7 @@ body: - area:container - area:cpu - area:db + - area:dc - area:deployment - area:destination - area:device diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index 206cc1c715..f50e6c6461 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -26,6 +26,7 @@ body: - area:container - area:cpu - area:db + - area:dc - area:deployment - area:destination - area:device diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index 1c9cfe8ef9..dad0158e23 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -35,6 +35,7 @@ body: - area:container - area:cpu - area:db + - area:dc - area:deployment - area:destination - area:device diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index c5ebd7f140..1ccb187bba 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -44,8 +44,8 @@ Currently, the following namespaces exist: - [Code](code.md) - [Container](container.md) - [CPU](cpu.md) -- [Datacenter](datacenter.md) - [Db](db.md) +- [DC](dc.md) - [Deployment](deployment.md) - [Destination](destination.md) - [Device](device.md) diff --git a/docs/attributes-registry/datacenter.md b/docs/attributes-registry/datacenter.md deleted file mode 100644 index 67f7fd0677..0000000000 --- a/docs/attributes-registry/datacenter.md +++ /dev/null @@ -1,24 +0,0 @@ - - - - - -# Datacenter - -## Datacenter Attributes - -Generic DataCenter infrastructure tagging. - -| Attribute | Type | Description | Examples | Stability | -| ------------------ | ------ | ---------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------- | -| `dc.cage` | string | Name of the cage | `cage-1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.chassis` | string | Name of the chassis the server lives in. | `pod-4` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.device.type` | string | Type of device used. | `server`; `chassis`; `network`; `pdu`; `switch`; `patch-panel` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.name` | string | Name of datacenter. | `dc-name` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.pod` | string | Name of the pod | `pod-4` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.provider.name` | string | Name of the datacenter provider | `aws`; `azure`; `gcp`; `corp` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.provider.type` | string | Type of datacenter | `cloud`; `colocation`; `internal` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.rack` | string | Name of the rack. | `rack-7` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.site` | string | Name of the datacenter site | `site-1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `dc.suite` | string | Name of the datacenter suite | `suite-5` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/docs/attributes-registry/dc.md b/docs/attributes-registry/dc.md new file mode 100644 index 0000000000..69341d678f --- /dev/null +++ b/docs/attributes-registry/dc.md @@ -0,0 +1,35 @@ + + + + + +# DC + +## Datacenter Attributes + +Generic DataCenter infrastructure tagging. + +| Attribute | Type | Description | Examples | Stability | +| ------------------ | ------ | -------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------- | +| `dc.cage` | string | Name of the cage [1] | `cage-1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.chassis` | string | Name of the chassis the server lives in. [2] | `pod-4` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.device.type` | string | Type of device used. | `server`; `chassis`; `network`; `pdu`; `switch`; `patch-panel` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.name` | string | Name of datacenter. | `dc-name` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.pod` | string | Name of the pod [3] | `pod-4` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.provider.type` | string | Type of datacenter | `cloud`; `colocation`; `internal` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.rack` | string | Name of the rack. [4] | `rack-7` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.site` | string | Name of the datacenter site [5] | `site-1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dc.suite` | string | Name of the datacenter suite [6] | `suite-5` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +**[1]:** This is a literal cage which is used to protect servers from potential intruders. + +**[2]:** A chassis is used to describe frame which contains servers together inside of a rack unit of a server rack. Typically used to take advantage of shared power supplies. + +**[3]:** This is a grouping of many servers typically several racks of servers. + +**[4]:** A tower frame which hold many servers and chassis. https://en.wikipedia.org/wiki/Rack_unit + +**[5]:** The name of the physical building. + +**[6]:** Typically the room in the building where the server cages are located. diff --git a/model/datacenter/registry.yaml b/model/dc/registry.yaml similarity index 68% rename from model/datacenter/registry.yaml rename to model/dc/registry.yaml index 6db675c1d3..4862d19e93 100644 --- a/model/datacenter/registry.yaml +++ b/model/dc/registry.yaml @@ -1,6 +1,5 @@ groups: - - id: registry.datacenter - stability: + - id: registry.dc type: attribute_group display_name: Datacenter Attributes brief: > @@ -11,11 +10,6 @@ groups: stability: experimental brief: 'Name of datacenter.' examples: ['dc-name'] - - id: dc.provider.name - type: string - stability: experimental - brief: 'Name of the datacenter provider' - examples: ['aws', 'azure', 'gcp', 'corp'] - id: dc.provider.type type: string stability: experimental @@ -26,33 +20,46 @@ groups: stability: experimental brief: 'Type of device used.' examples: ['server', 'chassis', 'network', 'pdu', 'switch', 'patch-panel'] - - id: dc.suite - type: string - stability: experimental - brief: 'Name of the datacenter suite' - examples: ['suite-5'] - id: dc.site type: string stability: experimental brief: 'Name of the datacenter site' + note: > + The name of the physical building. examples: ['site-1'] + - id: dc.suite + type: string + stability: experimental + brief: 'Name of the datacenter suite' + note: > + Typically the room in the building where the server cages are located. + examples: ['suite-5'] - id: dc.cage type: string stability: experimental brief: 'Name of the cage' + note: > + This is a literal cage which is used to protect servers from potential intruders. examples: ['cage-1'] - id: dc.pod type: string stability: experimental brief: 'Name of the pod' + note: > + This is a grouping of many servers typically several racks of servers. examples: ['pod-4'] - id: dc.chassis type: string stability: experimental brief: 'Name of the chassis the server lives in.' + note: > + A chassis is used to describe frame which contains servers together inside of a rack unit + of a server rack. Typically used to take advantage of shared power supplies. examples: ['pod-4'] - id: dc.rack type: string stability: experimental brief: 'Name of the rack.' + note: > + A tower frame which hold many servers and chassis. https://en.wikipedia.org/wiki/Rack_unit examples: ['rack-7'] diff --git a/model/datacenter/resources.yaml b/model/dc/resources.yaml similarity index 74% rename from model/datacenter/resources.yaml rename to model/dc/resources.yaml index 744a9a88c5..2e594c5e8a 100644 --- a/model/datacenter/resources.yaml +++ b/model/dc/resources.yaml @@ -1,12 +1,13 @@ groups: - - id: datacenter - stability: experimental + - id: dc type: resource + name: dc brief: > Generic DataCenter infrastructure tagging. attributes: - ref: dc.name - - ref: dc.provider.name + requirement_level: recommended + - ref: cloud.provider - ref: dc.provider.type - ref: dc.suite - ref: dc.site diff --git a/templates/registry/markdown/weaver.yaml b/templates/registry/markdown/weaver.yaml index ef9bc5c120..0f5a8a6736 100644 --- a/templates/registry/markdown/weaver.yaml +++ b/templates/registry/markdown/weaver.yaml @@ -13,6 +13,7 @@ acronyms: - CLR - CPU - CSI + - DC - DynamoDB - ECS - EKS