summaryrefslogtreecommitdiffstats
path: root/taskcluster/docker/index-task/README
blob: 9ec00e78972a67ab461488ea6f2e3ead7ad93a00 (plain)
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
Index-Image
===========

This image is designed to be used for indexing other tasks. It takes a task
definition as follows:
```js
{
  ...,
  scopes: [
    'index:insert-task:my-index.namespace',
    'index:insert-task:...',
  ],
  payload: {
    image: '...',
    env: {
      TARGET_TASKID: '<taskId-to-be-indexed>',
    },
    command: [
      'insert-indexes.js',
      'my-index.namespace.one',
      'my-index.namespace.two',
      '....',
    ],
    features: {
      taskclusterProxy: true,
    },
    maxRunTime: 600,
  },
}
```

As can be seen the `taskId` to be indexed is given by the environment variable
`TARGET_TASKID` and the `command` arguments specifies namespaces that it must
be index under. It is **important** to also include scopes on the form
`index:insert-task:<...>` for all namespaces `<...>` given as `command`
arguments.