Skip to content

Commit

Permalink
fixups: Add Experimental flag and missing name.
Browse files Browse the repository at this point in the history
  • Loading branch information
hdost committed Sep 22, 2024
1 parent 10d1a55 commit 2369cb4
Show file tree
Hide file tree
Showing 9 changed files with 63 additions and 40 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ body:
- area:container
- area:cpu
- area:db
- area:dc
- area:deployment
- area:destination
- area:device
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ body:
- area:container
- area:cpu
- area:db
- area:dc
- area:deployment
- area:destination
- area:device
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ body:
- area:container
- area:cpu
- area:db
- area:dc
- area:deployment
- area:destination
- area:device
Expand Down
2 changes: 1 addition & 1 deletion docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
24 changes: 0 additions & 24 deletions docs/attributes-registry/datacenter.md

This file was deleted.

35 changes: 35 additions & 0 deletions docs/attributes-registry/dc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--- Hugo front matter used to generate the website version of this page:
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# 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.
31 changes: 19 additions & 12 deletions model/datacenter/registry.yaml → model/dc/registry.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
groups:
- id: registry.datacenter
stability:
- id: registry.dc
type: attribute_group
display_name: Datacenter Attributes
brief: >
Expand All @@ -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
Expand All @@ -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']
7 changes: 4 additions & 3 deletions model/datacenter/resources.yaml → model/dc/resources.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions templates/registry/markdown/weaver.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ acronyms:
- CLR
- CPU
- CSI
- DC
- DynamoDB
- ECS
- EKS
Expand Down

0 comments on commit 2369cb4

Please sign in to comment.