From 4fcf80765a78641051f262d7f539223ba77a626b Mon Sep 17 00:00:00 2001 From: very-doge-wow <95224950+very-doge-wow@users.noreply.github.com> Date: Fri, 3 May 2024 11:52:35 +0200 Subject: [PATCH] refactor: example style (#92) Co-authored-by: fabianfgross --- EXAMPLE/prometheus.html | 120 ++++++++++++++++++---------------------- EXAMPLE/prometheus.md | 12 ++-- EXAMPLE/style.css | 58 ++++++++----------- 3 files changed, 81 insertions(+), 109 deletions(-) diff --git a/EXAMPLE/prometheus.html b/EXAMPLE/prometheus.html index 49a88a9..fdb8242 100644 --- a/EXAMPLE/prometheus.html +++ b/EXAMPLE/prometheus.html @@ -5,55 +5,41 @@ @@ -281,57 +267,51 @@

Values

-configmapReload.prometheus.enabled -If false, the configmap-reload container will not be deployed. -
configmapReload:
  prometheus:
    enabled: true
- - - -configmapReload.prometheus.image -configmap-reload container image -
configmapReload:
  prometheus:
    image:
      digest: ''
      pullPolicy: IfNotPresent
      repository: quay.io/prometheus-operator/prometheus-config-reloader
      tag: v0.72.0
- - - -configmapReload.prometheus.image.containerSecurityContext +configmapReload.prometheus.containerSecurityContext Security context to be added to configmap-reload container -
configmapReload:
  prometheus:
    image:
      containerSecurityContext: null
+
configmapReload:
  prometheus:
    containerSecurityContext: {}
-configmapReload.prometheus.image.digest -When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value). -
configmapReload:
  prometheus:
    image:
      digest: ''
+configmapReload.prometheus.enabled +If false, the configmap-reload container will not be deployed. +
configmapReload:
  prometheus:
    enabled: true
-configmapReload.prometheus.image.extraArgs +configmapReload.prometheus.extraArgs Additional configmap-reload container arguments -
configmapReload:
  prometheus:
    image:
      extraArgs: null
+
configmapReload:
  prometheus:
    extraArgs: {}
-configmapReload.prometheus.image.extraConfigmapMounts +configmapReload.prometheus.extraConfigmapMounts Additional configmap-reload mounts. -
configmapReload:
  prometheus:
    image:
      extraConfigmapMounts: null
+
configmapReload:
  prometheus:
    extraConfigmapMounts: []
extraConfigmapMounts:
  - name: prometheus-alerts
    mountPath: /etc/alerts.d
    subPath: ""
    configMap: prometheus-alerts
    readOnly: true
-configmapReload.prometheus.image.extraVolumeDirs +configmapReload.prometheus.extraVolumeDirs Additional configmap-reload volume directories -
configmapReload:
  prometheus:
    image:
      extraVolumeDirs: null
+
configmapReload:
  prometheus:
    extraVolumeDirs: []
-configmapReload.prometheus.image.extraVolumeMounts +configmapReload.prometheus.extraVolumeMounts Additional configmap-reload volume mounts -
configmapReload:
  prometheus:
    image:
      extraVolumeMounts: null
+
configmapReload:
  prometheus:
    extraVolumeMounts: []
-configmapReload.prometheus.image.resources -configmap-reload resource requests and limits. Ref: http://kubernetes.io/docs/user-guide/compute-resources/ -
configmapReload:
  prometheus:
    image:
      resources: null
+configmapReload.prometheus.image +configmap-reload container image +
configmapReload:
  prometheus:
    image:
      digest: ''
      pullPolicy: IfNotPresent
      repository: quay.io/prometheus-operator/prometheus-config-reloader
      tag: v0.72.0
+ + + +configmapReload.prometheus.image.digest +When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value). +
configmapReload:
  prometheus:
    image:
      digest: ''
@@ -341,6 +321,12 @@

Values

+configmapReload.prometheus.resources +configmap-reload resource requests and limits. Ref: http://kubernetes.io/docs/user-guide/compute-resources/ +
configmapReload:
  prometheus:
    resources: {}
+ + + configmapReload.reloadUrl URL for configmap-reload to use for reloads 
configmapReload:
  reloadUrl: ''
@@ -421,7 +407,7 @@

Values

server Configure the server component. -
Expand
server:
  affinity: {}
  alertmanagers: []
  automountServiceAccountToken: false
  baseURL: ''
  clusterRoleNameOverride: ''
  command: []
  configMapAnnotations: {}
  configMapOverrideName: ''
  configPath: /etc/config/prometheus.yml
  containerSecurityContext: {}
  defaultFlagsOverride: []
  deploymentAnnotations: {}
  dnsConfig: {}
  dnsPolicy: ClusterFirst
  emptyDir:
    sizeLimit: ''
  enableServiceLinks: true
  env: []
  exemplars: {}
  extraArgs: {}
  extraConfigmapLabels: {}
  extraConfigmapMounts: []
  extraFlags:
  - web.enable-lifecycle
  extraHostPathMounts: []
  extraInitContainers: []
  extraSecretMounts: []
  extraVolumeMounts: []
  extraVolumes: []
  global:
    evaluation_interval: 1m
    scrape_interval: 1m
    scrape_timeout: 10s
  hostAliases: []
  hostNetwork: false
  image:
    digest: ''
    pullPolicy: IfNotPresent
    repository: quay.io/prometheus/prometheus
    tag: ''
  ingress:
    annotations: {}
    enabled: false
    extraLabels: {}
    extraPaths: []
    hosts: []
    path: /
    pathType: Prefix
    tls: []
  livenessProbeFailureThreshold: 3
  livenessProbeInitialDelay: 30
  livenessProbePeriodSeconds: 15
  livenessProbeSuccessThreshold: 1
  livenessProbeTimeout: 10
  name: server
  nodeSelector: {}
  persistentVolume:
    accessModes:
    - ReadWriteOnce
    annotations: {}
    enabled: true
    existingClaim: ''
    labels: {}
    mountPath: /data
    size: 8Gi
    statefulSetNameOverride: ''
    subPath: ''
  podAnnotations: {}
  podAntiAffinity: ''
  podAntiAffinityTopologyKey: kubernetes.io/hostname
  podDisruptionBudget:
    enabled: false
    maxUnavailable: 1
  podLabels: {}
  podSecurityPolicy:
    annotations: {}
  portName: ''
  prefixURL: ''
  priorityClassName: ''
  probeHeaders: []
  probeScheme: HTTP
  readinessProbeFailureThreshold: 3
  readinessProbeInitialDelay: 30
  readinessProbePeriodSeconds: 5
  readinessProbeSuccessThreshold: 1
  readinessProbeTimeout: 4
  releaseNamespace: false
  remoteRead: []
  remoteWrite: []
  replicaCount: 1
  resources: {}
  retention: 15d
  retentionSize: ''
  revisionHistoryLimit: 10
  securityContext:
    fsGroup: 65534
    runAsGroup: 65534
    runAsNonRoot: true
    runAsUser: 65534
  service:
    additionalPorts: []
    annotations: {}
    clusterIP: ''
    enabled: true
    externalIPs: []
    gRPC:
      enabled: false
      servicePort: 10901
    labels: {}
    loadBalancerIP: ''
    loadBalancerSourceRanges: []
    servicePort: 80
    sessionAffinity: None
    statefulsetReplica:
      enabled: false
      replica: 0
    type: ClusterIP
  sidecarContainers: {}
  sidecarTemplateValues: {}
  startupProbe:
    enabled: false
    failureThreshold: 30
    periodSeconds: 5
    timeoutSeconds: 10
  statefulSet:
    annotations: {}
    enabled: false
    headless:
      annotations: {}
      gRPC:
        enabled: false
        servicePort: 10901
      labels: {}
      servicePort: 80
    labels: {}
    podManagementPolicy: OrderedReady
    pvcDeleteOnStsDelete: false
    pvcDeleteOnStsScale: false
  storagePath: ''
  strategy:
    type: Recreate
  tcpSocketProbeEnabled: false
  terminationGracePeriodSeconds: 300
  tolerations: []
  topologySpreadConstraints: []
  tsdb: {}
  useExistingClusterRoleName: null
  verticalAutoscaler:
    enabled: false
+
Expand
server:
  affinity: {}
  alertmanagers: []
  automountServiceAccountToken: false
  baseURL: ''
  clusterRoleNameOverride: ''
  command: []
  configMapAnnotations: {}
  configMapOverrideName: ''
  configPath: /etc/config/prometheus.yml
  containerSecurityContext: {}
  defaultFlagsOverride: []
  deploymentAnnotations: {}
  dnsConfig: {}
  dnsPolicy: ClusterFirst
  emptyDir:
    sizeLimit: ''
  enableServiceLinks: true
  env: []
  exemplars: {}
  extraArgs: {}
  extraConfigmapLabels: {}
  extraConfigmapMounts: []
  extraFlags:
  - web.enable-lifecycle
  extraHostPathMounts: []
  extraInitContainers: []
  extraSecretMounts: []
  extraVolumeMounts: []
  extraVolumes: []
  global:
    evaluation_interval: 1m
    scrape_interval: 1m
    scrape_timeout: 10s
  hostAliases: []
  hostNetwork: false
  image:
    digest: ''
    pullPolicy: IfNotPresent
    repository: quay.io/prometheus/prometheus
    tag: ''
  ingress:
    annotations: {}
    enabled: false
    extraLabels: {}
    extraPaths: []
    hosts: []
    path: /
    pathType: Prefix
    tls: []
  livenessProbeFailureThreshold: 3
  livenessProbeInitialDelay: 30
  livenessProbePeriodSeconds: 15
  livenessProbeSuccessThreshold: 1
  livenessProbeTimeout: 10
  name: server
  nodeSelector: {}
  persistentVolume:
    accessModes:
    - ReadWriteOnce
    annotations: {}
    enabled: true
    existingClaim: ''
    labels: {}
    mountPath: /data
    size: 8Gi
    statefulSetNameOverride: ''
    subPath: ''
  podAnnotations: {}
  podAntiAffinity: ''
  podAntiAffinityTopologyKey: kubernetes.io/hostname
  podDisruptionBudget:
    enabled: false
    maxUnavailable: 1
  podLabels: {}
  podSecurityPolicy:
    annotations: {}
  portName: ''
  prefixURL: ''
  priorityClassName: ''
  probeHeaders: []
  probeScheme: HTTP
  readinessProbeFailureThreshold: 3
  readinessProbeInitialDelay: 30
  readinessProbePeriodSeconds: 5
  readinessProbeSuccessThreshold: 1
  readinessProbeTimeout: 4
  releaseNamespace: false
  remoteRead: []
  remoteWrite: []
  replicaCount: 1
  resources: {}
  retention: 15d
  retentionSize: ''
  revisionHistoryLimit: 10
  securityContext:
    fsGroup: 65534
    runAsGroup: 65534
    runAsNonRoot: true
    runAsUser: 65534
  service:
    additionalPorts: []
    annotations: {}
    clusterIP: ''
    enabled: true
    externalIPs: []
    gRPC:
      enabled: false
      servicePort: 10901
    labels: {}
    loadBalancerIP: ''
    loadBalancerSourceRanges: []
    servicePort: 80
    sessionAffinity: None
    statefulsetReplica:
      enabled: false
      replica: 0
    type: ClusterIP
  sidecarContainers: {}
  sidecarTemplateValues: {}
  startupProbe:
    enabled: false
    failureThreshold: 30
    periodSeconds: 5
    timeoutSeconds: 10
  statefulSet:
    annotations: {}
    enabled: false
    headless:
      annotations: {}
      gRPC:
        enabled: false
        servicePort: 10901
      labels: {}
      servicePort: 80
    labels: {}
    podManagementPolicy: OrderedReady
    pvcDeleteOnStsDelete: false
    pvcDeleteOnStsScale: false
  storagePath: ''
  strategy:
    type: Recreate
  tcpSocketProbeEnabled: false
  terminationGracePeriodSeconds: 300
  tolerations: []
  topologySpreadConstraints: []
  tsdb: {}
  useExistingClusterRoleName: false
  verticalAutoscaler:
    enabled: false
@@ -445,7 +431,7 @@

Values

server.useExistingClusterRoleName Use a ClusterRole (and ClusterRoleBinding). If set to false, we define a RoleBinding in the defined namespaces ONLY. NB: because we need a Role with nonResourceURL's ("/metrics") - you must get someone with Cluster-admin privileges to define this role for you, before running with this setting enabled. This makes prometheus work - for users who do not have ClusterAdmin privs, but wants prometheus to operate on their own namespaces, instead of clusterwide. You MUST also set namespaces to the ones you have access to and want monitored by Prometheus. -
server:
  useExistingClusterRoleName: null
+
server:
  useExistingClusterRoleName: false
diff --git a/EXAMPLE/prometheus.md b/EXAMPLE/prometheus.md index cd1edcb..9ba842e 100644 --- a/EXAMPLE/prometheus.md +++ b/EXAMPLE/prometheus.md @@ -72,16 +72,16 @@ The following values can/will be used for deployments. | configmapReload | Monitors ConfigMap changes and POSTs to a URL. Ref: https://github.com/prometheus-operator/prometheus-operator/tree/main/cmd/prometheus-config-reloader |
Expand
configmapReload:
  env: []
  prometheus:
    containerSecurityContext: {}
    enabled: true
    extraArgs: {}
    extraConfigmapMounts: []
    extraVolumeDirs: []
    extraVolumeMounts: []
    image:
      digest: ''
      pullPolicy: IfNotPresent
      repository: quay.io/prometheus-operator/prometheus-config-reloader
      tag: v0.72.0
    name: configmap-reload
    resources: {}
  reloadUrl: ''
| | | configmapReload.env | env sets environment variables to pass to the container. Can be set as name/value pairs, read from secrets or configmaps. | 
configmapReload:
  env: []
|
Expand
env:
  - name: SOMEVAR
    value: somevalue
  - name: SOMEVARAGAIN
    value: somevalueanother
  - name: strawberry
    value: redanddelishous
  - name: melon
    value: greenandred
  - name: justanother
    value: dayinparadise
  - name: PASSWORD
    valueFrom:
      secretKeyRef:
        name: mysecret
        key: password
        optional: false
| | configmapReload.prometheus | Define values for the prometheus configuration. |
Expand
configmapReload:
  prometheus:
    containerSecurityContext: {}
    enabled: true
    extraArgs: {}
    extraConfigmapMounts: []
    extraVolumeDirs: []
    extraVolumeMounts: []
    image:
      digest: ''
      pullPolicy: IfNotPresent
      repository: quay.io/prometheus-operator/prometheus-config-reloader
      tag: v0.72.0
    name: configmap-reload
    resources: {}
| | +| configmapReload.prometheus.containerSecurityContext | Security context to be added to configmap-reload container | 
configmapReload:
  prometheus:
    containerSecurityContext: {}
| | | configmapReload.prometheus.enabled | If false, the configmap-reload container will not be deployed. | 
configmapReload:
  prometheus:
    enabled: true
| | +| configmapReload.prometheus.extraArgs | Additional configmap-reload container arguments | 
configmapReload:
  prometheus:
    extraArgs: {}
| | +| configmapReload.prometheus.extraConfigmapMounts | Additional configmap-reload mounts. | 
configmapReload:
  prometheus:
    extraConfigmapMounts: []
| 
extraConfigmapMounts:
  - name: prometheus-alerts
    mountPath: /etc/alerts.d
    subPath: ""
    configMap: prometheus-alerts
    readOnly: true
| +| configmapReload.prometheus.extraVolumeDirs | Additional configmap-reload volume directories | 
configmapReload:
  prometheus:
    extraVolumeDirs: []
| | +| configmapReload.prometheus.extraVolumeMounts | Additional configmap-reload volume mounts | 
configmapReload:
  prometheus:
    extraVolumeMounts: []
| | | configmapReload.prometheus.image | configmap-reload container image | 
configmapReload:
  prometheus:
    image:
      digest: ''
      pullPolicy: IfNotPresent
      repository: quay.io/prometheus-operator/prometheus-config-reloader
      tag: v0.72.0
| | -| configmapReload.prometheus.image.containerSecurityContext | Security context to be added to configmap-reload container | 
configmapReload:
  prometheus:
    image:
      containerSecurityContext: {}
| | | configmapReload.prometheus.image.digest | When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value). | 
configmapReload:
  prometheus:
    image:
      digest: ''
| | -| configmapReload.prometheus.image.extraArgs | Additional configmap-reload container arguments | 
configmapReload:
  prometheus:
    image:
      extraArgs: {}
| | -| configmapReload.prometheus.image.extraConfigmapMounts | Additional configmap-reload mounts. | 
configmapReload:
  prometheus:
    image:
      extraConfigmapMounts: {}
| 
extraConfigmapMounts:
  - name: prometheus-alerts
    mountPath: /etc/alerts.d
    subPath: ""
    configMap: prometheus-alerts
    readOnly: true
| -| configmapReload.prometheus.image.extraVolumeDirs | Additional configmap-reload volume directories | 
configmapReload:
  prometheus:
    image:
      extraVolumeDirs: {}
| | -| configmapReload.prometheus.image.extraVolumeMounts | Additional configmap-reload volume mounts | 
configmapReload:
  prometheus:
    image:
      extraVolumeMounts: {}
| | -| configmapReload.prometheus.image.resources | configmap-reload resource requests and limits. Ref: http://kubernetes.io/docs/user-guide/compute-resources/ | 
configmapReload:
  prometheus:
    image:
      resources: {}
| | | configmapReload.prometheus.name | configmap-reload container name | 
configmapReload:
  prometheus:
    name: configmap-reload
| | +| configmapReload.prometheus.resources | configmap-reload resource requests and limits. Ref: http://kubernetes.io/docs/user-guide/compute-resources/ | 
configmapReload:
  prometheus:
    resources: {}
| | | configmapReload.reloadUrl | URL for configmap-reload to use for reloads | 
configmapReload:
  reloadUrl: ''
| | | extraManifests | | 
extraManifests: []
| | | extraScrapeConfigs | | 
extraScrapeConfigs: ''
| | diff --git a/EXAMPLE/style.css b/EXAMPLE/style.css index ce9e4b4..cd2131f 100644 --- a/EXAMPLE/style.css +++ b/EXAMPLE/style.css @@ -1,50 +1,36 @@ -tr { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; -} - body { - padding: 0 2em; - font-family: Montserrat, sans-serif; - -webkit-font-smoothing: antialiased; - text-rendering: optimizeLegibility; - color: #444; - background: #eee; -} - -h1 { - font-weight: normal; - letter-spacing: -1px; - color: #34495E; + font-family: sans-serif; + margin: auto; + padding: 10px; + max-width: 80%; } -/* Styling for HTML tables */ table { + font-family: Arial, Helvetica, sans-serif; border-collapse: collapse; - width: 100%; + display: block; + overflow-x: auto; } -/* Styling for table headings */ -th { - background-color: lightblue; - color: black; +td, th { + border: 1px solid #ddd; + padding: 8px; } -/* Styling for table rows */ -tr:nth-child(even) { - background-color: #f2f2f2; /* Light gray background */ -} +tr:nth-child(even){background-color: #f2f2f2;} -tr:nth-child(odd) { - background-color: white; /* White background */ -} +tr:hover {background-color: #E0F2FF;} -/* Styling for table cells */ -td { - border: 1px solid black; /* Add borders to table cells */ +th { + padding-top: 12px; + padding-bottom: 12px; + text-align: left; + background-color: #0288d1; + color: white; } -/* Hover effect */ -tr:hover { - background-color: #cce6ff; /* Light blue background on hover */ +pre { + background-color: #E4E4E4; + padding: 0.5em; + border-radius: 5px; }