Skip to content

Commit

Permalink
[Maintenance] Use GoPretty for the Documentation (#1783)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ajanikow
ajanikow authored Dec 16, 2024
1 parent f16d663 commit f80ad84
Show file tree
Hide file tree
Showing 52 changed files with 752 additions and 743 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
- (Feature) (Networking) Gateway Options sync
- (Feature) Webhooks
- (Feature) (Platform) Add CA Integration propagation
- (Maintenance) Use GoPretty for the Documentation

## [1.2.43](https://github.com/arangodb/kube-arangodb/tree/1.2.43) (2024-10-14)
- (Feature) ArangoRoute CRD
Expand Down
134 changes: 67 additions & 67 deletions README.md
View file

Large diffs are not rendered by default.

76 changes: 38 additions & 38 deletions docs/features/README.md
View file

Large diffs are not rendered by default.

174 changes: 87 additions & 87 deletions docs/generated/actions.md
View file

Large diffs are not rendered by default.

72 changes: 36 additions & 36 deletions docs/generated/metrics/README.md
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_agency_cache_health_present.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Determines if local agency cache health is present

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_agency_cache_healthy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Determines if agency is healthy

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
8 changes: 4 additions & 4 deletions docs/generated/metrics/arangodb_operator_agency_cache_leaders.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Determines agency leader vote count. Should be always one

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| agent | Agent ID |
| name | Deployment Name |
| agent | Agent ID |
8 changes: 4 additions & 4 deletions docs/generated/metrics/arangodb_operator_agency_cache_member_commit_offset.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Determines agency member commit offset. Set to -1 if Agent is not reachable

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| agent | Agent ID |
| name | Deployment Name |
| agent | Agent ID |
8 changes: 4 additions & 4 deletions docs/generated/metrics/arangodb_operator_agency_cache_member_serving.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Determines if agency member is reachable

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| agent | Agent ID |
| name | Deployment Name |
| agent | Agent ID |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_agency_cache_present.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Determines if local agency cache is present

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_agency_cache_serving.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Determines if agency is serving

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_agency_errors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Current count of agency cache fetch errors

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_agency_fetches.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Current count of agency cache fetches

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_agency_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Current index of the agency cache

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
8 changes: 4 additions & 4 deletions docs/generated/metrics/arangodb_operator_deployment_conditions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Representation of the ArangoDeployment condition state (true/false)

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| condition | Condition Name |
| name | Deployment Name |
| condition | Condition Name |
12 changes: 6 additions & 6 deletions docs/generated/metrics/arangodb_operator_engine_assertions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Number of assertions invoked during Operator runtime

## Labels

| Label | Description |
|:-----:|:--------------|
| key | Assertion Key |
| Label | Description |
|:---:|:--- |
| key | Assertion Key |


## Alerting

| Priority | Query | Description |
|:--------:|:--------------------------------------------------:|:--------------------------------------------|
| Warning | irate(arangodb_operator_engine_assertions[1m]) > 1 | Trigger an alert if OPS attention is needed |
| Priority | Query | Description |
|:---:|:---:|:--- |
| Warning | irate(arangodb_operator_engine_assertions[1m]) > 1 | Trigger an alert if OPS attention is needed |
12 changes: 6 additions & 6 deletions docs/generated/metrics/arangodb_operator_engine_ops_alerts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ Counter for actions which requires ops attention

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |


## Alerting

| Priority | Query | Description |
|:--------:|:--------------------------------------------------:|:--------------------------------------------|
| Warning | irate(arangodb_operator_engine_ops_alerts[1m]) > 1 | Trigger an alert if OPS attention is needed |
| Priority | Query | Description |
|:---:|:---:|:--- |
| Warning | irate(arangodb_operator_engine_ops_alerts[1m]) > 1 | Trigger an alert if OPS attention is needed |
4 changes: 2 additions & 2 deletions docs/generated/metrics/arangodb_operator_engine_panics_recovered.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Number of Panics recovered inside Operator reconciliation loop. Section represen

## Labels

| Label | Description |
|:-------:|:--------------|
| Label | Description |
|:---:|:--- |
| section | Panic Section |
8 changes: 4 additions & 4 deletions docs/generated/metrics/arangodb_operator_kubernetes_client_request_errors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Number of Kubernetes Client request errors

## Labels

| Label | Description |
|:---------:|:-------------------------------------------------------------|
| component | K8S Resource name |
| verb | Verb (create,update,update-status,patch,delete,force-delete) |
| Label | Description |
|:---:|:--- |
| component | K8S Resource name |
| verb | Verb (create,update,update-status,patch,delete,force-delete) |
8 changes: 4 additions & 4 deletions docs/generated/metrics/arangodb_operator_kubernetes_client_requests.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Number of Kubernetes Client requests

## Labels

| Label | Description |
|:---------:|:-------------------------------------------------------------|
| component | K8S Resource name |
| verb | Verb (create,update,update-status,patch,delete,force-delete) |
| Label | Description |
|:---:|:--- |
| component | K8S Resource name |
| verb | Verb (create,update,update-status,patch,delete,force-delete) |
10 changes: 5 additions & 5 deletions docs/generated/metrics/arangodb_operator_members_conditions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Representation of the ArangoMember condition state (true/false)

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| member | Member ID |
| condition | Condition Name |
| name | Deployment Name |
| member | Member ID |
| condition | Condition Name |
16 changes: 8 additions & 8 deletions .../generated/metrics/arangodb_operator_members_unexpected_container_exit_codes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Counter of unexpected restarts in pod (Containers/InitContainers/EphemeralContai

## Labels

| Label | Description |
|:--------------:|:-------------------------------------------|
| namespace | Deployment Namespace |
| name | Deployment Name |
| member | Member ID |
| container | Container Name |
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| member | Member ID |
| container | Container Name |
| container_type | Container/InitContainer/EphemeralContainer |
| code | ExitCode |
| reason | Reason |
| code | ExitCode |
| reason | Reason |
4 changes: 2 additions & 2 deletions docs/generated/metrics/arangodb_operator_objects_processed.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Number of the processed objects

## Labels

| Label | Description |
|:-------------:|:--------------|
| Label | Description |
|:---:|:--- |
| operator_name | Operator Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_rebalancer_enabled.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Determines if rebalancer is enabled

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_rebalancer_moves_current.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Define how many moves are currently in progress

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_rebalancer_moves_failed.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Define how many moves failed

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_rebalancer_moves_generated.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Define how many moves were generated

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_rebalancer_moves_succeeded.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Define how many moves succeeded

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_resources_arangodeployment_accepted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Defines if ArangoDeployment has been accepted

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions ...erated/metrics/arangodb_operator_resources_arangodeployment_immutable_errors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Counter for deployment immutable errors

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_resources_arangodeployment_propagated.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Defines if ArangoDeployment Spec is propagated

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions ...nerated/metrics/arangodb_operator_resources_arangodeployment_status_restores.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Counter for deployment status restored

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions docs/generated/metrics/arangodb_operator_resources_arangodeployment_uptodate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Defines if ArangoDeployment is uptodate

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions ...rated/metrics/arangodb_operator_resources_arangodeployment_validation_errors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Counter for deployment validation errors

## Labels

| Label | Description |
|:---------:|:---------------------|
| Label | Description |
|:---:|:--- |
| namespace | Deployment Namespace |
| name | Deployment Name |
| name | Deployment Name |
6 changes: 3 additions & 3 deletions ...rated/metrics/arangodb_operator_resources_arangodeploymentreplication_active.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Defines if ArangoDeploymentReplication is configured and running

## Labels

| Label | Description |
|:---------:|:--------------------------------|
| Label | Description |
|:---:|:--- |
| namespace | DeploymentReplication Namespace |
| name | DeploymentReplication Name |
| name | DeploymentReplication Name |
6 changes: 3 additions & 3 deletions ...rated/metrics/arangodb_operator_resources_arangodeploymentreplication_failed.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Defines if ArangoDeploymentReplication is in Failed phase

## Labels

| Label | Description |
|:---------:|:--------------------------------|
| Label | Description |
|:---:|:--- |
| namespace | DeploymentReplication Namespace |
| name | DeploymentReplication Name |
| name | DeploymentReplication Name |
Loading

0 comments on commit f80ad84

Please sign in to comment.