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.

Sign up for GitHub

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

Jump to bottom

kata-deploy: improving the runtimeclasses checker and documentation #9822

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

kata-deploy: improving the runtimeclasses checker and documentation #9822

wants to merge 7 commits into from

Commits on Jun 26, 2024

  1. workflows/kata-runtime-classes-sync: move checker to a script 

    Created the tools/packaging/kata-deploy/local-build/check-runtimeclasses.sh
script and adjusted the worfklow to call it. This way developers can run
the checker locally more easily.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
    @wainersm
    wainersm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    548facb View commit details
    Browse the repository at this point in the history

  2. kata-deploy/local-build/check-runtimeclasses: export LC_ALL=C 

    As is, check-runtimeclasses.sh behavior is unexpected because the
`sort` command relies on LC_ALL. For example, in some environment
it can sort "kata-qemu-se.yaml kata-qemu-sev.yaml" and in other
"kata-qemu-sev.yaml "kata-qemu-se.yaml".

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
    @wainersm
    wainersm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    dbd9c29 View commit details
    Browse the repository at this point in the history

  3. kata-deploy/local-build/check-runtimeclasses: major refactor the code 

    To allow running the checker many times on same environment and providing
a more user-friendly results.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
    @wainersm
    wainersm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    21be1fe View commit details
    Browse the repository at this point in the history

  4. workflows/kata-runtime-classes-sync: run only on given files changed 

    This workflow is meant to check changes in
tools/packaging/kata-deploy/runtimeclasses so let's not run on every and each
PR.

While here, it was gave a name to the job so that on UI it will show up as
'Static checks / kata-deploy-runtime-classes-check' similarly to other
static checks (e.g. 'Static checks / check-kernel-config-version').

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
    @wainersm
    wainersm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    54a80c0 View commit details
    Browse the repository at this point in the history

  5. kata-deploy: add howto "add a new runtimeClass" 

    Created a `Development` section in kata-deploy's README and documented
the process to add a new runtimeClass.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
    @wainersm
    wainersm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    dd3ebce View commit details
    Browse the repository at this point in the history

  6. spell-check: add runtimeClass to dictionary 

    The spell-checker was complaining about `runtimeClass` word.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
    @wainersm
    wainersm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    754fec7 View commit details
    Browse the repository at this point in the history

  7. kata-deploy/local-build/check-runtimeclasses: inspect SHIMS list 

    The list of SHIMS in kata-deploy/base/kata-deploy.yaml and
kata-cleanup/base/kata-cleanup.yaml should match the runtimeClasses
files (some exceptions apply). Added a checker for that in
check-runtimeclasses.sh.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
    @wainersm
    wainersm committed Jun 26, 2024
    Configuration menu
    Copy the full SHA
    fbaa7a6 View commit details
    Browse the repository at this point in the history