Skip to content

Commit

Permalink
Try out jsonschema2md
Browse files Browse the repository at this point in the history
  • Loading branch information
@Izzette
Izzette committed Mar 31, 2024
1 parent 258f398 commit 23533ea
Show file tree
Hide file tree
Showing 42 changed files with 1,397 additions and 2 deletions.
25 changes: 25 additions & 0 deletions doc/schema/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# README

## Top-level Schemas

* [Metric Record](./kube_transition_metrics.md "JSON schema for metric logs emitted by the kube-transition-metrics controller") – `schemas/kube_transition_metrics.schema.json`

## Other Schemas

### Objects

* [Container Metrics](./kube_transition_metrics-properties-metrics-properties-container-metrics.md "Included if kube_transition_metric_type is equal to \"container\"") – `schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container`

* [Image Pull Metrics](./kube_transition_metrics-properties-metrics-properties-image-pull-metrics.md "Included if kube_transition_metric_type is equal to \"image_pull\"") – `schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/image_pull`

* [Metrics](./kube_transition_metrics-properties-metrics.md "The metrics pertaining to pod_name") – `schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics`

* [Pod Metrics](./kube_transition_metrics-properties-metrics-properties-pod-metrics.md "Included if kube_transition_metric_type is equal to \"pod\"") – `schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/pod`

### Arrays



## Version Note

The schemas linked above follow the JSON Schema Spec version: `https://json-schema.org/draft/2020-12/schema`
15 changes: 15 additions & 0 deletions doc/schema/kube_transition_metrics-properties-message.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Message Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/message
```

An additional message emitted along with metrics.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## message Type

`string` ([Message](kube_transition_metrics-properties-message.md))
19 changes: 19 additions & 0 deletions doc/schema/kube_transition_metrics-properties-metric-timestamp.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Metric Timestamp Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/time
```

The time at which this metric was emitted.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## time Type

`string` ([Metric Timestamp](kube_transition_metrics-properties-metric-timestamp.md))

## time Constraints

**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
15 changes: 15 additions & 0 deletions doc/schema/kube_transition_metrics-properties-metrics-allof-0.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled undefined type in Metric Record Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/allOf/0
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## 0 Type

unknown
15 changes: 15 additions & 0 deletions doc/schema/kube_transition_metrics-properties-metrics-allof-1-oneof-0.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled undefined type in Metric Record Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/allOf/1/oneOf/0
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## 0 Type

unknown
15 changes: 15 additions & 0 deletions doc/schema/kube_transition_metrics-properties-metrics-allof-1-oneof-1.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled undefined type in Metric Record Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/allOf/1/oneOf/1
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## 1 Type

unknown
15 changes: 15 additions & 0 deletions doc/schema/kube_transition_metrics-properties-metrics-allof-1-oneof-2.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled undefined type in Metric Record Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/allOf/1/oneOf/2
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## 2 Type

unknown
23 changes: 23 additions & 0 deletions doc/schema/kube_transition_metrics-properties-metrics-allof-1.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Untitled undefined type in Metric Record Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/allOf/1
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## 1 Type

merged type ([Details](kube_transition_metrics-properties-metrics-allof-1.md))

one (and only one) of

* [Untitled undefined type in Metric Record](kube_transition_metrics-properties-metrics-allof-1-oneof-0.md "check type definition")

* [Untitled undefined type in Metric Record](kube_transition_metrics-properties-metrics-allof-1-oneof-1.md "check type definition")

* [Untitled undefined type in Metric Record](kube_transition_metrics-properties-metrics-allof-1-oneof-2.md "check type definition")
15 changes: 15 additions & 0 deletions ...cs-properties-metrics-properties-container-metrics-properties-container-name.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Container name Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/name
```

The name of the container to which metrics pertain

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## name Type

`string` ([Container name](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-container-name.md))
15 changes: 15 additions & 0 deletions ...cs-properties-metrics-properties-container-metrics-properties-init-container.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Init Container Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/init_container
```

True if the container is an init container, otherwise false.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## init\_container Type

`boolean` ([Init Container](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-init-container.md))
15 changes: 15 additions & 0 deletions ...s-metrics-properties-container-metrics-properties-pod-initialized-to-running.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Pod Initialized to Running Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/initialized_to_running_seconds
```

The time in seconds from the Pod becoming initialized (all init containers exited 0) to this container running. Only set for non-init containers.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## initialized\_to\_running\_seconds Type

`number` ([Pod Initialized to Running](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-pod-initialized-to-running.md))
15 changes: 15 additions & 0 deletions ...operties-container-metrics-properties-previous-container-finished-to-running.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Previous Container Finished to Running Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/previous_to_running_seconds
```

The time in seconds from the previous init container becoming Ready (exited 0) to this container running. Only set for init containers, absent for the first init container.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## previous\_to\_running\_seconds Type

`number` ([Previous Container Finished to Running](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-previous-container-finished-to-running.md))
19 changes: 19 additions & 0 deletions ...properties-metrics-properties-container-metrics-properties-running-timestamp.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Running Timestamp Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/running_timestamp
```

The timestamp for when the container first entered Running state (first fork(2)/execve(2) in container environment). In the event of a pod restart, this timestamp is NOT updated.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## running\_timestamp Type

`string` ([Running Timestamp](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-running-timestamp.md))

## running\_timestamp Constraints

**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
15 changes: 15 additions & 0 deletions ...roperties-metrics-properties-container-metrics-properties-running-to-ready-1.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Running to Ready Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/started_to_ready_seconds
```

The time in seconds from the container becoming started to this container ready. Only set for non-init containers.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## started\_to\_ready\_seconds Type

`number` ([Running to Ready](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-running-to-ready-1.md))
15 changes: 15 additions & 0 deletions ...-properties-metrics-properties-container-metrics-properties-running-to-ready.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Running to Ready Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/running_to_ready_seconds
```

The time in seconds from the container becoming running to this container ready. In init containers, this is the time the container exited with a successful status.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## running\_to\_ready\_seconds Type

`number` ([Running to Ready](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-running-to-ready.md))
15 changes: 15 additions & 0 deletions ...roperties-metrics-properties-container-metrics-properties-running-to-started.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Running to Started Schema

```txt
schemas/kube_transition_metrics.schema.json#/properties/kube_transition_metrics/properties/container/properties/running_to_started_seconds
```

The time in seconds from the container becoming running to this container started. Only set for non-init containers.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [kube\_transition\_metrics.schema.json\*](kube_transition_metrics.schema.json "open original schema") |

## running\_to\_started\_seconds Type

`number` ([Running to Started](kube_transition_metrics-properties-metrics-properties-container-metrics-properties-running-to-started.md))
Loading

0 comments on commit 23533ea

Please sign in to comment.