Skip to content

Commit 548f012

Browse files
(Update) Values.yaml example for Helm
Updated the values.yaml for helm
1 parent 25daa1c commit 548f012

File tree

1 file changed

+112
-53
lines changed

1 file changed

+112
-53
lines changed

docs/platform/delegates/delegate-reference/YAML/example-kubernetes-manifest-harness-delegate.md

Lines changed: 112 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -252,32 +252,39 @@ spec:
252252
<summary>Helm chart default `values.yaml` file</summary>
253253
<br />
254254

255-
[Helm chart default `values.yaml` file](https://github.com/harness/delegate-helm-chart/blob/main/harness-delegate-ng/values.yaml)
255+
For the newest references, please utilize the most up-to-date [Helm chart default `values.yaml` file example found in our repository](https://github.com/harness/delegate-helm-chart/blob/main/harness-delegate-ng/values.yaml)
256256

257257
```yaml
258-
# Default configuration values for the Harness Delegate NextGen.
258+
# Default values for delegate-ng.
259259
# This is a YAML-formatted file.
260260
# Declare variables to be passed into your templates.
261261

262262
image:
263263
pullPolicy: Always
264+
# Uncomment below lines to use a custom registry + repository, a different repository or a different tag, this will override the delegateDockerImage
265+
# registry: null
266+
# repository: null
267+
# tag: null
264268

265269
fullnameOverride: ""
266270

271+
mTLS:
272+
secretName: ""
273+
267274
serviceAccount:
268-
# Specifies whether a service account should be created.
275+
# Specifies whether a service account should be created
269276
create: true
270-
# Annotations to add to the service account.
277+
# Annotations to add to the service account
271278
annotations: {}
272279
# The name of the service account to use.
273-
# If not set and create is true, a name is generated using the fullname template.
280+
# If not set and create is true, a name is generated using the fullname template
274281
name: ""
275282

276283
service:
277-
# type: ClusterIP
284+
# type: ClusterIP
278285
port: 8080
279286

280-
# Edit this if you want to enable horizontal pod autoscaling.
287+
# Edit this if you want to enable horizontal pod autoscaling
281288
autoscaling:
282289
enabled: false
283290
minReplicas: 1
@@ -297,23 +304,30 @@ delegateName: harness-delegate-ng
297304

298305
deployMode: "KUBERNETES"
299306

300-
delegateDockerImage: harness/delegate:24.01.82108
307+
delegateDockerImage: harness/delegate:25.08.86503
301308

302-
# Annotations for delegate deployment; Prometheus is added by default.
309+
commonAnnotations: {} # Annotations that will be applied to all resources
310+
delegateAnnotations: {} # Annotations that will be applied to both pod and deployment spec for Delegate
311+
# Annotations for delegate deployment, prometheus is added by default
303312
annotations:
304313
prometheus.io/scrape: "true"
305314
prometheus.io/port: "3460"
306315
prometheus.io/path: "/api/metrics"
307316

317+
318+
commonLabels: {} # Labels that will be applied to all resources
319+
delegatePodLabels: {} # Labels that will be applied to pod spec
320+
delegateLabels: {} # Labels that will be applied to both deployment and pod spec for Delegate
321+
308322
imagePullSecret: ""
309323

310-
# Endpoint that will point to the Harness platform. For accessing SaaS platform use the default value.
324+
# Endpoint that will point to harness platform. For accessing SAAS platform use the default value.
311325
managerEndpoint: https://app.harness.io
312326

313-
# If socket connection is not supported, set this flag to true to poll tasks using REST API calls.
327+
# If socket connection is not supported, set this flag to true to poll tasks using rest API calls
314328
pollForTasks: "false"
315329

316-
# Change this to alter startup probe and liveness probe settings.
330+
# Change this to alter startup probe and liveness probe settings
317331
startupProbe:
318332
initialDelaySeconds: 10
319333
periodSeconds: 10
@@ -326,27 +340,45 @@ livenessProbe:
326340
failureThreshold: 3
327341
timeoutSeconds: 1
328342

329-
# Add delegate description and tags.
343+
# Add delegate description and tags
330344
description: ""
331345
tags: ""
332346

333-
# Permissions for the installed delegate, could be CLUSTER_ADMIN, CLUSTER_VIEWER, or NAMESPACE_ADMIN.
334-
# For using a custom role: Create a role in the Kubernetes cluster and refer to the role in the k8sPermissionsType field.
335-
# For example, if your custom role name is custom-role, then you need to add k8sPermissionsType: "custom-role".
347+
# Permissions for installed delegate, could be CLUSTER_ADMIN, CLUSTER_VIEWER or NAMESPACE_ADMIN
348+
# For using custom role: Create role in kubernetes cluster and refer role in k8sPermissionsType field.
349+
# for example if your custom role name is custom-role, then you need to add
350+
#k8sPermissionsType: "custom-role"
336351
k8sPermissionsType: "CLUSTER_ADMIN"
337352

338-
# Number of pod replicas running the delegate image.
353+
# Number of pod replica running delegate image
339354
replicas: 1
340355

341-
# The deployment strategy. Can be "RollingUpdate" or "Recreate". Can be useful if a rolling update is not
356+
# The deployment strategy. Can be "RollingUpdate" or "Recreate". Can be usefull if a rolling update is not
342357
# possible due to custom volumes or mounts that can only be attached to a single pod.
343358
deploymentStrategy: "RollingUpdate"
344359

345-
# Resource limits of the container running the delegate image in Kubernetes.
360+
# Rolling update configuration (only applies when deploymentStrategy is "RollingUpdate").
361+
# By default, these are not set so Kubernetes uses its own defaults (currently 25%).
362+
# Uncomment and set if you want to override the defaults. You may use integers or percentage strings (e.g., "25%")
363+
# rollingUpdate:
364+
# # Maximum number of pods that can be created above the desired replica count during updates
365+
# maxSurge: "25%"
366+
# # Maximum number of pods that can be unavailable during the update process
367+
# maxUnavailable: "25%"
368+
369+
# Resource limits of container running delegate image in kubernetes
370+
# If you want to set custom resource limits, uncomment the below line and set the values for cpu and memory request/limit
371+
# resources:
372+
# limits:
373+
# cpu: 1
374+
# memory: 2048Mi
375+
# requests:
376+
# cpu: 1
377+
# memory: 2048Mi
346378
cpu: 1
347379
memory: 2048
348380

349-
# Script to run before delegate installation.
381+
# Script to run before delegate installation
350382
initScript: ""
351383

352384
# This is a constant, don't change this.
@@ -357,59 +389,75 @@ javaOpts: "-Xms64M"
357389
upgrader:
358390
enabled: true
359391
upgraderDockerImage: "harness/upgrader:latest"
392+
registryMirror: ""
393+
image:
394+
pullPolicy: Always
395+
# Uncomment below lines to use a custom registry + repository, a different repository or a different tag, this will override the upgraderDockerImage
396+
# registry: null
397+
# repository: null
398+
# tag: null
399+
400+
# Schedule for the upgrader cronjob (cron format)
401+
schedule: "0 */1 * * *"
402+
403+
imagePullSecret: ""
404+
360405
cronJobServiceAccountName: "upgrader-cronjob-sa"
361-
# Use an existing Secret that stores the UPGRADER_TOKEN key instead of creating a new one. The value should be set with the `UPGRADER_TOKEN` key inside the secret.
362-
## The use of external secrets allows you to manage credentials from external tools like Vault, 1Password, SealedSecrets, among others.
363-
## If set, this parameter takes precedence over "upgraderToken".
364-
## Recommendations:
406+
# Use existing Secret which stores UPGRADER_TOKEN key instead of creating a new one. The value should be set with the `UPGRADER_TOKEN` key inside the secret.
407+
## The use of external secrets allows you to manage credentials from external tools like Vault, 1Password, SealedSecrets, among other.
408+
## If set, this parameter takes precedence over "upgraderToken"
409+
## Recommendation:
365410
## - Use different Secrets names for `existingUpgraderToken` and `existingDelegateToken`.
366-
## - Do not use Secrets managed by other Helm deployments.
411+
## - Do not use Secrets managed by other helm delpoyments.
367412
existingUpgraderToken: ""
368413

414+
# Set security context for upgrader
415+
securityContext:
416+
369417
# This field is DEPRECATED, DON'T OVERRIDE/USE THIS!!
370-
# To set root/non-root access and other security context, use the delegateSecurityContext field below.
418+
# To set root/non-root access and other security context use delegateSecurityContext field below.
371419
# Not removing this field to maintain backward compatibility.
372420
securityContext:
373421
runAsRoot: true
374422

375-
# Set security context for delegate.
423+
# Set security context for delegate
376424
delegateSecurityContext:
377425
allowPrivilegeEscalation: false
378426
runAsUser: 0
379427

380428
nextGen: true
381429

382-
# Below are the required fields. No default values are populated for these.
383-
# Please add values for the delegate to work.
430+
# Below are the required fields, no default values are populated for these.
431+
# Please add values for delegate to work.
384432

385-
# Account Id to which the delegate will be connecting.
433+
# Account Id to which the delegate will be connecting
386434
accountId: ""
387-
# Delegate Token.
435+
# Delegate Token
388436
delegateToken: ""
389-
# Use an existing Secret which stores the DELEGATE_TOKEN key instead of creating a new one. The value should be set with the `DELEGATE_TOKEN` key inside the secret.
390-
## The use of external secrets allows you to manage credentials from external tools like Vault, 1Password, SealedSecrets, among others.
437+
# Use existing Secret which stores DELEGATE_TOKEN key instead of creating a new one. The value should be set with the `DELEGATE_TOKEN` key inside the secret.
438+
## The use of external secrets allows you to manage credentials from external tools like Vault, 1Password, SealedSecrets, among other.
391439
## If set, this parameter takes precedence over "delegateToken".
392440
## Recommendations:
393441
## - Use different Secrets names for `existingUpgraderToken` and `existingDelegateToken`.
394-
## - Do not use Secrets managed by other Helm deployments.
442+
## - Do not use Secrets managed by other helm delpoyments.
395443
existingDelegateToken: ""
396444

397-
# Configure a Kubernetes build farm to use self-signed certificates.
445+
# Configure a Kubernetes build farm to use self-signed certificates
398446
# https://developer.harness.io/docs/continuous-integration/use-ci/set-up-build-infrastructure/configure-a-kubernetes-build-farm-to-use-self-signed-certificates/
399447
# CAUTION
400-
# Make sure that the destination path is not the same as the default CA certificate path of the corresponding container image.
448+
# Make sure that the destination path is not same as the default CA certificate path of the corresponding container image.
401449
#
402450
# If you want to override the default certificate file, make sure the Kubernetes secret or config map (from step one) includes all certificates required by the pipelines that will use this build infrastructure.
403-
# This is the LEGACY way to add a cert; we recommend using destinationCaPath. Please follow the document:
451+
# This is LEGACY way to adding cert, we recommend to use destinationCaPath, please follow the document:
404452
# https://developer.harness.io/docs/continuous-integration/use-ci/set-up-build-infrastructure/configure-a-kubernetes-build-farm-to-use-self-signed-certificates/
405453
shared_certificates:
406454
# Location in the delegate to which the ca_bundle will be mounted or a location in the custom delegate image to which the
407-
# CA chain has already been placed as part of creating the custom delegate image.
455+
# CA chain has already been placed as part of creating the custom delegate image
408456
certs_path: /shared/customer-artifacts/certificates/ca.bundle
409-
# Example Certificate Chain (Multi-line files).
410-
# ca_bundle should be the text of the CA Bundle to include in a secret.
457+
# Example Certificate Chain (Multi-line files )
458+
# ca_bundle should be the text of the CA Bundle to include in a secret
411459
#
412-
# Note: when defined, the secret will be mounted to the certs_path location on the delegate.
460+
# Note: when defined, the secret will be mounted to the certs_path location on the delegate
413461
ca_bundle: # |
414462
# -----BEGIN CERTIFICATE-----
415463
# XXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -418,39 +466,51 @@ shared_certificates:
418466
# XXXXXXXXXXXXXXXXXXXXXXXXXXX
419467
# -----END CERTIFICATE-------
420468

421-
# CI Mount targets are the locations where the secrets should be mounted in the CI Images. This will share any CA chain defined in the certs_path key to any CI image
469+
# CI Mount targets are the locations that the secrets should be mounted in the CI Images. This will share any CA chain defined in the certs_path key to any CI image
422470
# configured in the pod.
423471
ci_mount_targets:
424472
# - /etc/ssl/certs/ca-bundle.crt
425473
# - /etc/ssl/certs/ca-certificates.crt
426474
# - /kaniko/ssl/certs/additional-ca-cert-bundle.crt
427475

428-
# Additional environment variables for the delegate pod.
476+
# additional init containers for the delegate pod
477+
custom_init_containers:
478+
# - name: init-container
479+
# image: busybox
480+
# command: ['sh', '-c', 'echo "Hello from init container!"']
481+
482+
# additional sidecar containers for the delegate pod
483+
custom_containers:
484+
# - name: sidecar
485+
# image: busybox
486+
# command: ['sh', '-c', 'echo "Hello from sidecar!"']
487+
488+
# additional environment variables for the delegate pod
429489
custom_envs:
430490
# - name: DELEGATE_TASK_CAPACITY
431491
# value: "10"
432492

433-
# Mounts for the delegate pod.
493+
# mounts for the delegate pod
434494
custom_mounts:
435495
# - name: certs
436496
# mountPath: /shared/customer-artifacts/certificates/
437497

438-
# Volumes to add to the delegate container.
498+
# volumes to add to the delegate container
439499
custom_volumes:
440500
# - name: certs
441501
# persistentVolumeClaim:
442502
# claimName: harness-delegate-ng-certs
443503

444-
# Minimum number of seconds for which a newly-created Pod should be ready without any of its containers crashing, for it to be considered available.
445-
# This is set for improving stability during upgrade. It will tell Kubernetes to wait at least this amount of seconds before removing the old pod after the new one becomes ready.
504+
# minimum number of seconds for which a newly created Pod should be ready without any of its containers crashing, for it to be considered available.
505+
# This is set for improving stability during upgrade. It will tell kubernetes to wait at least this amount of seconds before removing the old pod after the new one becomes ready.
446506
minReadySeconds: 120
447507

448-
# Enable the cluster role needed for CCM cost visibility.
449-
# Not needed if k8sPermissionsType: "CLUSTER_ADMIN" is specified.
508+
# Enable the cluster role needed for CCM cost visibility
509+
# Not needed if k8sPermissionsType: "CLUSTER_ADMIN" is specified
450510
ccm:
451511
visibility: false
452512

453-
# Use this field to add additional labels.
513+
# Use this field to add additional labels
454514
additionalLabels: {}
455515
# nologging: "true"
456516

@@ -473,10 +533,9 @@ upgraderCustomCa:
473533
delegateCustomCa:
474534
secretName:
475535

476-
# This is the recommended way to use custom certs with CI.
477-
# For more information, go to https://developer.harness.io/docs/continuous-integration/use-ci/set-up-build-infrastructure/k8s-build-infrastructure/configure-a-kubernetes-build-farm-to-use-self-signed-certificates/
536+
# This is recommended way of using custom certs with CI.
537+
# Please refer: https://developer.harness.io/docs/continuous-integration/use-ci/set-up-build-infrastructure/k8s-build-infrastructure/configure-a-kubernetes-build-farm-to-use-self-signed-certificates/
478538
destinationCaPath:
479-
480539
```
481540
482541
</details>

0 commit comments

Comments
 (0)