Skip to content

Commit

Permalink
update documents
Browse files Browse the repository at this point in the history 
Signed-off-by: Ruben Vargas <[email protected]>
  • Loading branch information
@rubenvp8510
rubenvp8510 committed Nov 18, 2024
1 parent 29b6c6e commit 3615794
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 96 deletions.
62 changes: 0 additions & 62 deletions docs/operator/config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,6 @@
# More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion: ""

# CacheNamespace if specified restricts the manager's cache to watch objects in
# the desired namespace Defaults to all namespaces
#
# Note: If a namespace is specified, controllers can still Watch for a
# cluster-scoped resource (e.g Node). For namespaced resources the cache
# will only hold objects from the desired namespace.
cacheNamespace: ""

# Controller contains global configuration options for controllers
# registered within this manager.
controller:

# CacheSyncTimeout refers to the time limit set to wait for syncing caches.
# Defaults to 2 minutes if not set.
cacheSyncTimeout: 0

# GroupKindConcurrency is a map from a Kind to the number of concurrent reconciliation
# allowed for that controller.
#
# When a controller is registered within this manager using the builder utilities,
# users have to specify the type the controller reconciles in the For(...) call.
# If the object's kind passed matches one of the keys in this map, the concurrency
# for that controller is set to the number specified.
#
# The key is expected to be consistent in form with GroupKind.String(),
# e.g. ReplicaSet in apps group (regardless of version) would be `ReplicaSet.apps`.
groupKindConcurrency:
"key": 0

# RecoverPanic indicates if panics should be recovered.
recoverPanic: false

# Distribution defines the operator distribution name.
distribution: ""

Expand Down Expand Up @@ -171,12 +139,6 @@ featureGates:
# when using HTTPEncryption or GRPCEncryption.
tlsProfile: ""

# GracefulShutdownTimeout is the duration given to runnable to stop before the manager actually returns on stop.
# To disable graceful shutdown, set to time.Duration(0)
# To use graceful shutdown without timeout, set to a negative duration, e.G. time.Duration(-1)
# The graceful shutdown is skipped for safety reasons in case the leader election lease is lost.
gracefulShutDown: 0h

# Health contains the controller health configuration
health:

Expand All @@ -185,12 +147,6 @@ health:
# It can be set to "0" or "" to disable serving the health probe.
healthProbeBindAddress: ""

# LivenessEndpointName, defaults to "healthz"
livenessEndpointName: ""

# ReadinessEndpointName, defaults to "readyz"
readinessEndpointName: ""

# Kind is a string value representing the REST resource this object represents.
# Servers may infer this from the endpoint the client submits requests to.
# Cannot be updated.
Expand Down Expand Up @@ -246,27 +202,9 @@ metrics:
# It can be set to "0" to disable the metrics serving.
bindAddress: ""

# SyncPeriod determines the minimum frequency at which watched resources are
# reconciled. A lower period will correct entropy more quickly, but reduce
# responsiveness to change if there are many watched resources. Change this
# value only if you know what you are doing. Defaults to 10 hours if unset.
# there will a 10 percent jitter between the SyncPeriod of all controllers
# so that all controllers will not send list requests simultaneously.
syncPeriod: 0h

# Webhook contains the controllers webhook configuration
webhook:

# CertDir is the directory that contains the server key and certificate.
# if not set, webhook server would look up the server key and certificate in
# {TempDir}/k8s-webhook-server/serving-certs. The server key and certificate
# must be named tls.key and tls.crt, respectively.
certDir: ""

# Host is the hostname that the webhook server binds to.
# It is used to set webhook.Server.Host.
host: ""

# Port is the port that the webhook server serves at.
# It is used to set webhook.Server.Port.
port: 0
14 changes: 7 additions & 7 deletions docs/spec/tempo.grafana.com_tempomonolithics.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ spec: # TempoMonolithicSpec defines the desir
otlp: # OTLP defines the ingestion configuration for the OTLP protocol.
grpc: # GRPC defines the OTLP over gRPC configuration.
enabled: true # Enabled defines if OTLP over gRPC is enabled. Default: enabled.
tls: # TLS defines the TLS configuration for OTLP/gRPC ingestion. On OpenShift when operator config `servingCertsService` and TLS is enabled but no `certName` and `caName` are provided it will use OpenShift serving certificate service.
tls: # TLS defines the TLS configuration for OTLP/gRPC ingestion. On OpenShift when operator config `servingCertsService` and TLS is enabled but no `certName` and `caName` are provided it will use OpenShift serving certificate service.
enabled: false # Enabled defines if TLS is enabled.
caName: "" # CA is the name of a ConfigMap containing a CA certificate (service-ca.crt). It needs to be in the same namespace as the Tempo custom resource.
certName: "" # Cert is the name of a Secret containing a certificate (tls.crt) and private key (tls.key). It needs to be in the same namespace as the Tempo custom resource.
minVersion: "" # MinVersion defines the minimum acceptable TLS version.
http: # HTTP defines the OTLP over HTTP configuration.
enabled: true # Enabled defines if OTLP over HTTP is enabled. Default: enabled.
tls: # TLS defines the TLS configuration for OTLP/HTTP ingestion. On OpenShift when operator config `servingCertsService` and TLS is enabled but no `certName` and `caName` are provided it will use OpenShift serving certificate service.
tls: # TLS defines the TLS configuration for OTLP/HTTP ingestion. On OpenShift when operator config `servingCertsService` and TLS is enabled but no `certName` and `caName` are provided it will use OpenShift serving certificate service.
enabled: false # Enabled defines if TLS is enabled.
caName: "" # CA is the name of a ConfigMap containing a CA certificate (service-ca.crt). It needs to be in the same namespace as the Tempo custom resource.
certName: "" # Cert is the name of a Secret containing a certificate (tls.crt) and private key (tls.key). It needs to be in the same namespace as the Tempo custom resource.
Expand All @@ -27,7 +27,7 @@ spec: # TempoMonolithicSpec defines the desir
enabled: false # Defines if the authentication will be enabled for jaeger UI.
sar: "" # SAR defines the SAR to be used in the oauth-proxy default is "{"namespace": "<tempo_stack_namespace>", "resource": "pods", "verb": "get"}
resources: # Resources defines the compute resource requirements of the OAuth Proxy container. The OAuth Proxy performs authentication and authorization of incoming requests to Jaeger UI when multi-tenancy is disabled.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
- name: "" # Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
limits: # Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
cpu: "750m"
Expand All @@ -48,7 +48,7 @@ spec: # TempoMonolithicSpec defines the desir
termination: "" # Termination specifies the termination type.
servicesQueryDuration: "" # ServicesQueryDuration defines how long the services will be available in the services list
resources: # Resources defines the compute resource requirements of the Jaeger UI container.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
- name: "" # Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
limits: # Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
cpu: "750m"
Expand Down Expand Up @@ -87,7 +87,7 @@ spec: # TempoMonolithicSpec defines the desir
- ""
mode: "static" # Mode defines the multitenancy mode.
resources: # Resources defines the compute resource requirements of the gateway container. The gateway performs authentication and authorization of incoming requests when multi-tenancy is enabled.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
- name: "" # Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
limits: # Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
cpu: "750m"
Expand Down Expand Up @@ -134,7 +134,7 @@ spec: # TempoMonolithicSpec defines the desir
podAntiAffinity: {} # Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
nodeSelector: {} # NodeSelector defines which labels are required by a node to schedule the pod onto it.
resources: # Resources defines the compute resource requirements of the Tempo container.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
claims: # Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
- name: "" # Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
limits: # Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
cpu: "750m"
Expand All @@ -154,6 +154,6 @@ status: # TempoMonolithicStatus defines the obs
observedGeneration: 0 # observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason: "" # reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status: "" # status of the condition, one of True, False, Unknown.
type: "" # type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
type: "" # type of condition in CamelCase or in foo.example.com/CamelCase.
operatorVersion: "" # Version of the Tempo Operator.
tempoVersion: "" # Version of the managed Tempo instance.
Loading

0 comments on commit 3615794

Please sign in to comment.