go:generate docgen types.go types_doc.go Configuration
## Job
Job is a single job to be executed by apollo.
A job contains providers and deployments required to be done
and some steps to be taken to achieve a desired scan.
A job is just an input and is immutable. The state of a job
is maintained in other variables instead of the Job struct.
name string
Name of the Job
Examples:
``` yaml
name: 443-httpx-internet-wide
```
key string
Key contains a key input of a certain type
Valid values:
- dns
- http
- headless
description string
Description contains a description of the job
Examples:
``` yaml
description: Runs masscan on port 443 followed by httpx
```
providers map[string]map[string]string
Providers contains a list of infrastructure providers
for the current scan.
Examples:
``` yaml
providers:
apollo-digitalocean:
access-token: 1sBKi2VGbAaifbg6NDvAdcyp8Uo
api-key: 1sBKhzvzQJc9TKwic4vFiQO61FH
```
InternalOptions contains internal configuration options for scheduler
Examples:
``` yaml
internal-options:
bulk-size: 10000 # BulkSize is the number of items to process per node at once.
scheduling-workers: 100 # SchedulingWorkers is the number of scheduling workers to use for ssh.
```
## InternalOptions
InternalOptions contains internal configuration options for scheduler
Appears in:
- Job.internal-options
``` yaml
bulk-size: 10000 # BulkSize is the number of items to process per node at once.
scheduling-workers: 100 # SchedulingWorkers is the number of scheduling workers to use for ssh.
```
bulk-size int
BulkSize is the number of items to process per node at once.
Examples:
``` yaml
bulk-size: 10000
```
scheduling-workers int
SchedulingWorkers is the number of scheduling workers to use for ssh.
Examples:
``` yaml
scheduling-workers: 10
```