Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ecerulm opened this issue Oct 2, 2024 · 0 comments
Open

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

ecerulm opened this issue Oct 2, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest-accepted hacktoberfest accepted

Comments

@ecerulm
Copy link

ecerulm commented Oct 2, 2024

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 <module>
    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

@ecerulm ecerulm changed the title document jobservice.job_logger in document jobservice.job_logger in configure-yml-file.md Oct 2, 2024
@Vad1mo Vad1mo added enhancement New feature or request good first issue Good for newcomers hacktoberfest-accepted hacktoberfest accepted labels Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest-accepted hacktoberfest accepted
Projects
None yet
Development

No branches or pull requests

2 participants