goharbor / goharbor/website

document jobservice.job_logger in configure-yml-file.md

Open
#577 0 comments 1 reaction 0 assignees View on GitHub
enhancement good first issue hacktoberfest-accepted
Dominant language
HTML
Stars
46
Forks
222
PR merge metrics
No merged PRs in 30d

Description

The

https://goharbor.io/docs/2.11.0/install-config/configure-yml-file/
https://github.com/goharbor/website/blob/main/docs/install-config/configure-yml-file.md

does not mention

```
jobservice:
# The jobLoggers backend name, only support "STD_OUTPUT", "FILE" and/or "DB"
job_loggers:
- STD_OUTPUT
- FILE
```

and it seems to be a required configuration

```
sudo ./install.sh
...
[Step 4]: preparing harbor configs ...
prepare base dir is set to /root/harbor
Traceback (most recent call last):
File "/usr/src/app/main.py", line 15, in
cli()
File "/usr/lib/python3.11/site-packages/click/core.py", line 1137, in __call__
return self.main(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/site-packages/click/core.py", line 1062, in main
rv = self.invoke(ctx)
^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/site-packages/click/core.py", line 1668, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/site-packages/click/core.py", line 1404, in invoke
return ctx.invoke(self.callback, **ctx.params)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/site-packages/click/core.py", line 763, in invoke
return __callback(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/src/app/commands/prepare.py", line 33, in prepare
config_dict = parse_yaml_config(conf, with_trivy=with_trivy)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/src/app/utils/configs.py", line 225, in parse_yaml_config
config_dict['job_loggers'] = js_config["job_loggers"]
~~~~~~~~~^^^^^^^^^^^^^^^
KeyError: 'job_loggers'
```

So far undocumented but required/mandatory configuration parameters that I found
* `jobservice.logger_sweeper_duration`
* `jobservice.job_logger`
* `notification.webhook_job_http_client_timeout`

as a workaround one need to look into the the installer and look at the `harbor.yml.tmpl`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.