If your Satellites will be running in a Docker container, you can use our Helm chart to configure and deploy them.

To use the Helm chart:

  1. Clone the lightstep-satellite-helm-chart to a local directory.

  2. Configure the chart for your Satellites using the values.yaml file. Please see Satellite Configuration Parameters for a full listing and expanded explanations of variables and recommended settings.

    If you are happy with the default port numbers and don’t need TLS, you only need to modify the following settings:
    satelliteKey(or collector_satellite_key_secret_name and collector_satellite_key_secret_key)
    collector-pool
    bytes_per_project

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# Default values for lightstep.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
# Eventual wishlist: # Implement statsD as sidecar [[ chose not to do. to be considered if needed by customer. ]]

#TODO: Input your satellite key.  Satellites will not run without a valid key.  You may use either a plain text Satellite key or an existing secret with the Satellite key stored.

replicaCount: 1

image:
  repository: lightstep/collector
  pullPolicy: IfNotPresent

imagePullSecrets: []
nameOverride: ""
fullnameOverride: ""

serviceAccount:
  # Specifies whether a service account should be created
  create: false
  # Annotations to add to the service account
  annotations: {}
  # The name of the service account to use.
  # If not set and create is true, a name is generated using the fullname template
  name:

podSecurityContext: {}
  # fsGroup: 2000

securityContext: {}
  # capabilities:
  #   drop:
  #   - ALL
  # readOnlyRootFilesystem: true
  # runAsNonRoot: true
  # runAsUser: 1000

service:
  type: ClusterIP
  httpPort: 8181
  grpcinsecure: 8184

ingress:
  enabled: false
  annotations: {}

  hosts:
    - host: chart-example.local
      paths: []
  tls: []
  #  - secretName: chart-example-tls
  #    hosts:
  #      - chart-example.local


#For details on the Lightstep configuration parameters, please refer to: https://docs.lightstep.com/docs/satellite-configuration-parameters

lightstep:
  #REQUIRED: Input your Satellite API Key
  satelliteKey: ""
  #OR
  collector_satellite_key_secret_name: ""
  collector_satellite_key_secret_key: ""

  # $ kubectl describe secret collector_satellite_key_secret_name
  # Name:         collector_satellite_key_secret_name
  # Namespace:    default
  # Labels:       <none>
  # Annotations:  <none>
  # Type:  Opaque
  # Data
  # ====
  # collector_satellite_key_secret_key:  390 bytes

  #Single Project Mode details
  disable_access_token_checking: false
  project_name: ""

  #Optional configs
  collector_pool: my-satellite-pool
  bytes_per_project: "1000000000"
  bytes_per_project_override:
  guid:
  diagnostic_port: 8000
  admin_plain_port: 8180
  admin_secure_port: 9090
  http_plain_port: 8181
  http_secure_port: 9191
  grpc_plain_port: 8184
  grpc_secure_port: 9292
  plain_port: 8383
  secure_port: 9393
  tls_cert_prefix:
  collector_ingestion_tags:

resources:
  limits:
    memory: 16Gi
    cpu: 2
  requests:
    memory: 16Gi
    cpu: 2


nodeSelector: {}

tolerations: []

affinity: {}

statsd:
    enabled: true
    host: 127.0.0.1
    port: 8125
    export_statsd: true                               #If true, dogStatsD will be ignored
    prefix: "lightstep.prod.us-west-1"
    satellite_prefix: "satellite-canary"
    client_prefix: "client_via_canary"
    dogStatsD: false                                  #If true, will output dogStatsD instead of statsD
    dogStatsDTags: "pool:us-west-1,canary:true"
  1. Run helm install satellite lightstep-satellite-helm-chart, using the file path to your installation directory.

After startup, check the diagnostics page (http://\{satellite\_host\}:8000/diagnostics) to view the Satellite configuration. Follow these instructions to further validate your installation and troubleshoot any issues.

You configure your instrumentation to communicate with your Satellites by providing their location. If you are using a single Satellite, you provide the DNS name or IP address of that Satellite. For more than one, use the name or address of the load balancer you’ve deployed. Find out how to do that in the language-specific Quick Start guides.

By default, client libraries use secure connections. If you’ve configured your Satellites to use plainport connections, you must configure your tracer appropriately.