github.com/verrazzano/verrazzano@v1.7.0/platform-operator/thirdparty/charts/jaegertracing/jaeger-operator/README.md (about)

     1  # jaeger-operator
     2  
     3  [jaeger-operator](https://github.com/jaegertracing/jaeger-operator) is a Kubernetes operator.
     4  
     5  ## Install
     6  
     7  ```console
     8  $ helm install jaegertracing/jaeger-operator
     9  ```
    10  
    11  ## Introduction
    12  
    13  This chart bootstraps a jaeger-operator deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
    14  
    15  ## Prerequisites
    16  
    17  - Kubernetes 1.19+
    18  - Helm 3
    19  - cert-manager 1.6.1+ installed, or certificate for webhook service in a secret
    20  
    21  ## Check compability matrix
    22  See the compatibility matrix [here](./COMPATIBILITY.md).
    23  
    24  ## Installing the Chart
    25  
    26  Add the Jaeger Tracing Helm repository:
    27  
    28  ```console
    29  $ helm repo add jaegertracing https://jaegertracing.github.io/helm-charts
    30  ```
    31  
    32  To install the chart with the release name `my-release` in `observability` namespace: 
    33  
    34  ```console
    35  $ helm install my-release jaegertracing/jaeger-operator -n observability
    36  ```
    37  
    38  The command deploys jaeger-operator on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
    39  
    40  > **Tip**: List all releases using `helm list`
    41  
    42  ## Uninstalling the Chart
    43  
    44  To uninstall/delete the `my-release` deployment:
    45  
    46  ```console
    47  $ helm delete my-release
    48  ```
    49  
    50  The command removes all the Kubernetes components associated with the chart and deletes the release.
    51  
    52  ## Configuration
    53  
    54  The following table lists the configurable parameters of the jaeger-operator chart and their default values.
    55  
    56  | Parameter               | Description                                                                                                 | Default                         |
    57  | :---------------------- | :---------------------------------------------------------------------------------------------------------- | :------------------------------ |
    58  | `serviceExtraLabels`    | Additional labels to jaeger-operator service  | `{}`
    59  | `extraLabels`           | Additional labels to jaeger-operator deployment  | `{}`
    60  | `image.repository`      | Controller container image repository                                                                       | `jaegertracing/jaeger-operator` |
    61  | `image.tag`             | Controller container image tag                                                                              | `1.42.0`                        |
    62  | `image.pullPolicy`      | Controller container image pull policy                                                                      | `IfNotPresent`                  |
    63  | `jaeger.create`         | Jaeger instance will be created                                                                             | `false`                         |
    64  | `jaeger.spec`           | Jaeger instance specification                                                                               | `{}`                            |
    65  | `rbac.create`           | All required roles and rolebindings will be created                                                         | `true`                          |
    66  | `serviceAccount.create` | Service account to use                                                                                      | `true`                          |
    67  | `rbac.pspEnabled`       | Pod security policy for pod will be created and included in rbac role                                       | `false`                         |
    68  | `rbac.clusterRole`      | ClusterRole will be used by operator ServiceAccount                                                         | `false`                         |
    69  | `serviceAccount.name`   | Service account name to use. If not set and create is true, a name is generated using the fullname template | `nil`                           |
    70  | `extraEnv`              | Additional environment variables passed to the operator. For example:   name: LOG-LEVEL   value: debug      | `[]`                            |
    71  | `resources`             | K8s pod resources                                                                                           | `None`                          |
    72  | `nodeSelector`          | Node labels for pod assignment                                                                              | `{}`                            |
    73  | `tolerations`           | Toleration labels for pod assignment                                                                        | `[]`                            |
    74  | `affinity`              | Affinity settings for pod assignment                                                                        | `{}`                            |
    75  | `securityContext`       | Security context for pod                                                                                    | `{}`                            |
    76  | `priorityClassName`     | Priority class name for the pod                                                                             | `None`                          |
    77  
    78  Specify each parameter you'd like to override using a YAML file as described above in the [installation](#installing-the-chart) section.
    79  
    80  You can also specify any non-array parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
    81  
    82  ```console
    83  $ helm install jaegertracing/jaeger-operator --name my-release \
    84      --set rbac.create=false
    85  ```
    86  
    87  To install the chart without creating the CRDs (any files under `chart/crds`) make use of the `--skip-crds` flag. For example,
    88  
    89  ```console
    90  $ helm install jaegertracing/jaeger-operator --name my-release \
    91      --skip-crds
    92  ```
    93  
    94  ## After the Helm Installation
    95  
    96  ### Creating a new Jaeger instance
    97  
    98  The simplest possible way to install is by creating a YAML file like the following:
    99  
   100  ```YAML
   101  apiVersion: jaegertracing.io/v1
   102  kind: Jaeger
   103  metadata:
   104    name: simplest
   105  ```
   106  
   107  The YAML file can then be used with `kubectl`:
   108  
   109  ```console
   110  $ kubectl apply -f simplest.yaml
   111  ```
   112  
   113  ### Creating a new Jaeger with ElasticSearch
   114  
   115  To do that you need to have an ElasticSearch installed in your Kubernetes cluster or install one using the [Helm Chart](https://github.com/helm/charts/tree/master/incubator/elasticsearch) available for that.
   116  
   117  After that just deploy the following manifest:
   118  
   119  ```YAML
   120  # setup an elasticsearch with `make es`
   121  apiVersion: jaegertracing.io/v1
   122  kind: Jaeger
   123  metadata:
   124    name: simple-prod
   125  spec:
   126    strategy: production
   127    storage:
   128      type: elasticsearch
   129      options:
   130        es:
   131          server-urls: http://elasticsearch:9200
   132          username: elastic
   133          password: changeme
   134  ```
   135  
   136  The YAML file can then be used with `kubectl`:
   137  
   138  ```console
   139  $ kubectl apply -f simple-prod.yaml
   140  ```