8000 [Maintenance] Use GoPretty for the Documentation (#1783) · arangodb/kube-arangodb@f80ad84 · GitHub
[go: up one dir, main page]
Skip to content

Commit f80ad84

Browse files
ajanikowajanikow
authored
[Maintenance] Use GoPretty for the Documentation (#1783)
1 parent f16d663 commit f80ad84
  • arangodb_operator_engine_ops_alerts.md
  • arangodb_operator_engine_panics_recovered.md
  • arangodb_operator_kubernetes_client_request_errors.md
  • arangodb_operator_kubernetes_client_requests.md
  • arangodb_operator_members_conditions.md
  • arangodb_operator_members_unexpected_container_exit_codes.md
  • arangodb_operator_objects_processed.md
  • arangodb_operator_rebalancer_enabled.md
  • arangodb_operator_rebalancer_moves_current.md
  • arangodb_operator_rebalancer_moves_failed.md
  • arangodb_operator_rebalancer_moves_generated.md
  • arangodb_operator_rebalancer_moves_succeeded.md
  • arangodb_operator_resources_arangodeployment_accepted.md
  • arangodb_operator_resources_arangodeployment_immutable_errors.md
  • arangodb_operator_resources_arangodeployment_propagated.md
  • arangodb_operator_resources_arangodeployment_status_restores.md
  • arangodb_operator_resources_arangodeployment_uptodate.md
  • arangodb_operator_resources_arangodeployment_validation_errors.md
  • arangodb_operator_resources_arangodeploymentreplication_active.md
  • arangodb_operator_resources_arangodeploymentreplication_failed.md
  • arangodb_resources_deployment_config_map_duration.md
  • arangodb_resources_deployment_config_map_inspected.md
  • go.mod
  • go.sum
  • internal
  • pkg/util

    • Some content is hidden

    Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

    52 files changed

    +752
    -743
    lines changed

    ‎CHANGELOG.md

    Lines changed: 1 addition & 0 deletions
    Original file line numberDiff line numberDiff line change
    @@ -35,6 +35,7 @@
    3535
    - (Feature) (Networking) Gateway Options sync
    3636
    - (Feature) Webhooks
    3737
    - (Feature) (Platform) Add CA Integration propagation
    38+
    - (Maintenance) Use GoPretty for the Documentation
    3839

    3940
    ## [1.2.43](https://github.com/arangodb/kube-arangodb/tree/1.2.43) (2024-10-14)
    4041
    - (Feature) ArangoRoute CRD

    ‎README.md

    Lines changed: 67 additions & 67 deletions
    Large diffs are not rendered by default.

    ‎docs/features/README.md

    Lines changed: 38 additions & 38 deletions
    Large diffs are not rendered by default.

    ‎docs/generated/actions.md

    Lines changed: 87 additions & 87 deletions
    Large diffs are not rendered by default.

    ‎docs/generated/metrics/README.md

    Lines changed: 36 additions & 36 deletions
    Large diffs are not rendered by default.

    ‎docs/generated/metrics/arangodb_operator_agency_cache_health_present.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Determines if local agency cache health is present
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_agency_cache_healthy.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Determines if agency is healthy
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_agency_cache_leaders.md

    Lines changed: 4 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,8 +12,8 @@ Determines agency leader vote count. Should be always one
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    19-
    | agent | Agent ID |
    18+
    | name | Deployment Name |
    19+
    | agent | Agent ID |

    ‎docs/generated/metrics/arangodb_operator_agency_cache_member_commit_offset.md

    Lines changed: 4 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,8 +12,8 @@ Determines agency member commit offset. Set to -1 if Agent is not reachable
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    19-
    | agent | Agent ID |
    18+
    | name | Deployment Name |
    19+
    | agent | Agent ID |

    ‎docs/generated/metrics/arangodb_operator_agency_cache_member_serving.md

    Lines changed: 4 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,8 +12,8 @@ Determines if agency member is reachable
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    19-
    | agent | Agent ID |
    18+
    | name | Deployment Name |
    19+
    | agent | Agent ID |

    ‎docs/generated/metrics/arangodb_operator_agency_cache_present.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Determines if local agency cache is present
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_agency_cache_serving.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Determines if agency is serving
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_agency_errors.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Current count of agency cache fetch errors
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_agency_fetches.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Current count of agency cache fetches
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_agency_index.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Current index of the agency cache
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_deployment_conditions.md

    Lines changed: 4 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,8 +12,8 @@ Representation of the ArangoDeployment condition state (true/false)
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    19-
    | condition | Condition Name |
    18+
    | name | Deployment Name |
    19+
    | condition | Condition Name |

    ‎docs/generated/metrics/arangodb_operator_engine_assertions.md

    Lines changed: 6 additions & 6 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,13 +12,13 @@ Number of assertions invoked during Operator runtime
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:-----:|:--------------|
    17-
    | key | Assertion Key |
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    17+
    | key | Assertion Key |
    1818

    1919

    2020
    ## Alerting
    2121

    22-
    | Priority | Query | Description |
    23-
    |:--------:|:--------------------------------------------------:|:--------------------------------------------|
    24-
    | Warning | irate(arangodb_operator_engine_assertions[1m]) > 1 | Trigger an alert if OPS attention is needed |
    22+
    | Priority | Query | Description |
    23+
    |:---:|:---:|:--- |
    24+
    | Warning | irate(arangodb_operator_engine_assertions[1m]) > 1 | Trigger an alert if OPS attention is needed |

    ‎docs/generated/metrics/arangodb_operator_engine_ops_alerts.md

    Lines changed: 6 additions & 6 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,14 +12,14 @@ Counter for actions which requires ops attention
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |
    1919

    2020

    2121
    ## Alerting
    2222

    23-
    | Priority | Query | Description |
    24-
    |:--------:|:--------------------------------------------------:|:--------------------------------------------|
    25-
    | Warning | irate(arangodb_operator_engine_ops_alerts[1m]) > 1 | Trigger an alert if OPS attention is needed |
    23+
    | Priority | Query | Description |
    24+
    |:---:|:---:|:--- |
    25+
    | Warning | irate(arangodb_operator_engine_ops_alerts[1m]) > 1 | Trigger an alert if OPS attention is needed |

    ‎docs/generated/metrics/arangodb_operator_engine_panics_recovered.md

    Lines changed: 2 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,6 +12,6 @@ Number of Panics recovered inside Operator reconciliation loop. Section represen
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:-------:|:--------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | section | Panic Section |

    ‎docs/generated/metrics/arangodb_operator_kubernetes_client_request_errors.md

    Lines changed: 4 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Number of Kubernetes Client request errors
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:-------------------------------------------------------------|
    17-
    | component | K8S Resource name |
    18-
    | verb | Verb (create,update,update-status,patch,delete,force-delete) |
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    17+
    | component | K8S Resource name |
    18+
    | verb | Verb (create,update,update-status,patch,delete,force-delete) |

    ‎docs/generated/metrics/arangodb_operator_kubernetes_client_requests.md

    Lines changed: 4 additions & 4 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Number of Kubernetes Client requests
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:-------------------------------------------------------------|
    17-
    | component | K8S Resource name |
    18-
    | verb | Verb (create,update,update-status,patch,delete,force-delete) |
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    17+
    | component | K8S Resource name |
    18+
    | verb | Verb (create,update,update-status,patch,delete,force-delete) |

    ‎docs/generated/metrics/arangodb_operator_members_conditions.md

    Lines changed: 5 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,9 +12,9 @@ Representation of the ArangoMember condition state (true/false)
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    19-
    | member | Member ID |
    20-
    | condition | Condition Name |
    18+
    | name | Deployment Name |
    19+
    | member | Member ID |
    20+
    | condition | Condition Name |

    ‎docs/generated/metrics/arangodb_operator_members_unexpected_container_exit_codes.md

    Lines changed: 8 additions & 8 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,12 +12,12 @@ Counter of unexpected restarts in pod (Containers/InitContainers/EphemeralContai
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:--------------:|:-------------------------------------------|
    17-
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    19-
    | member | Member ID |
    20-
    | container | Container Name |
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    17+
    | namespace | Deployment Namespace |
    18+
    | name | Deployment Name |
    19+
    | member | Member ID |
    20+
    | container | Container Name |
    2121
    | container_type | Container/InitContainer/EphemeralContainer |
    22-
    | code | ExitCode |
    23-
    | reason | Reason |
    22+
    | code | ExitCode |
    23+
    | reason | Reason |

    ‎docs/generated/metrics/arangodb_operator_objects_processed.md

    Lines changed: 2 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,6 +12,6 @@ Number of the processed objects
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:-------------:|:--------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | operator_name | Operator Name |

    ‎docs/generated/metrics/arangodb_operator_rebalancer_enabled.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Determines if rebalancer is enabled
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_rebalancer_moves_current.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Define how many moves are currently in progress
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_rebalancer_moves_failed.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Define how many moves failed
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_rebalancer_moves_generated.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Define how many moves were generated
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_rebalancer_moves_succeeded.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Define how many moves succeeded
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeployment_accepted.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Defines if ArangoDeployment has been accepted
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeployment_immutable_errors.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Counter for deployment immutable errors
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeployment_propagated.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Defines if ArangoDeployment Spec is propagated
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeployment_status_restores.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Counter for deployment status restored
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeployment_uptodate.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Defines if ArangoDeployment is uptodate
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeployment_validation_errors.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Counter for deployment validation errors
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:---------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | Deployment Namespace |
    18-
    | name | Deployment Name |
    18+
    | name | Deployment Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeploymentreplication_active.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Defines if ArangoDeploymentReplication is configured and running
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:--------------------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | DeploymentReplication Namespace |
    18-
    | name | DeploymentReplication Name |
    18+
    | name | DeploymentReplication Name |

    ‎docs/generated/metrics/arangodb_operator_resources_arangodeploymentreplication_failed.md

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -12,7 +12,7 @@ Defines if ArangoDeploymentReplication is in Failed phase
    1212

    1313
    ## Labels
    1414

    15-
    | Label | Description |
    16-
    |:---------:|:--------------------------------|
    15+
    | Label | Description |
    16+
    |:---:|:--- |
    1717
    | namespace | DeploymentReplication Namespace |
    18-
    | name | DeploymentReplication Name |
    18+
    | name | DeploymentReplication Name |

    0 commit comments

    Comments
     (0)
    0