feat: Add project column to the images table and refactor ImageRef related logics

[jopemachine]

Overview

• Adds project column to the images table.
• Refactors ImageRef to be a simple type that only holds data (dataclass).
  • Add project field. Previously, the name field mixed the project and image names, but now ImageRef.name only contains the image name, and the project value is separately in the ImageRef.project field.

Why

Saving the project value in the DB is necessary because the string corresponding to project may differ depending on the type of container repository, making it impossible to separate the project from the image canonical string.

The project value should also be included in the ImageRef field, and ImageRef should be refactored into a simple struct that only holds data, separated from the existing complex logic of parsing image strings.

Refactoring details

This PR performs relatively large-scale refactoring to add a project field to the ImageRef corresponding to the ImageRow.

ParsedImageStr type

• ParsedImageStr is a namedtuple that represents the parsed result of an image string, containing properties such as canonical.
• ParsedImageStr type is similar to the ImageRef type, but it cannot distinguish between the project and image name and does not include architecture information, so it does not correspond to a single ImageRow.
• ImageRef.parse_image_str() returns a ParsedImageStr type, which can be used to create an ImageRef. But you can also create an ImageRef instance directly using ImageRef.from_image_str().

Comparison of ImageRef.parse_image_str() with the existing ImageRef() constructor

• In the existing code, known_registries* which contains contextual information about registries, was separately provided and used to parse the image_str (value)
• However, in this refactoring PR, ImageRef is now just a simple dataclass, so the parsing logic previously handled by the ImageRef constructor is now handled by ImageRef.parse_image_str().
• ImageRef.parse_image_str() can only accept a single registry as an argument, unlike the existing code, which allows for multiple registries through known_registries.
• The image string parsing logic still behaves the same as before. For example, the behavior when passing ['*'] to the known_registries parameter in the original code can be replicated by passing "*" to the registry argument in ImageRef.parse_image_str(). For more details, please refer to the comments in the ImageRef.parse_image_str() function and the test_docker.py test code.

ImageIdentifier type

• A tuple of image canonical string, and architecture.
• Uniquely corresponds one-to-one with an ImageRow.
• ImageRow.resolve() can now be operated using ImageIdentifier, in addition to ImageAlias and ImageRef.

Add IMAGE_REF type to ExtTypes

• Adds the ImageRef type to msgpack to enable the exchange of ImageRef type objects in RPC communication between the managers and agents.

Etcs

• Modify variables name image_ref that are not of the ImageRef type (but are actually str).
• This PR includes the content of chore: Remove session scheduler related types no longer used #2705 to avoid unnecessary updates.

---

Checklist: (if applicable)

• Milestone metadata specifying the target backport version
• Migration script for filling the Image.project column
• Test case(s) to:
  • Demonstrate the difference of before/after

---

📚 Documentation preview 📚: https://sorna--2707.org.readthedocs.build/en/2707/

---

📚 Documentation preview 📚: https://sorna-ko--2707.org.readthedocs.build/ko/2707/

[jopemachine]

• feat: Allow empty image name #2831
• feat: Replace image rescan command's --local flag with the local type ContainerRegistry record #2665
• feat: Support AWS ECR Private Container Registry based on PostgreSQL #2624
• feat: Support AWS ECR Public Container Registry based on PostgreSQL #2623
• feat: Support GitLab Container Registry based on PostgreSQL #2622
• feat: Support GitHub Container Registry based on PostgreSQL #2621
• feat: Support docker image manifest v2 schema1 scanning #2815
• refactor: Base ContainerRegistry's scan_tag and implement MEDIA_TYPE_DOCKER_MANIFEST type handling #2620
• feat: Implement ID based client workflow to ContainerRegistry graphql API #2615
• feat: Add project column to the images table and refactor ImageRef related logics #2707 👈
• feat: Migrate container registry config storage from Etcd to PostgreSQL #1917
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @jopemachine and the rest of your teammates on Graphite

[achimnol]

• Could we make ImageRef also a dataclass?
• Could you elaborate why we need a separate ParsedImageStr?

[jopemachine]

@achimnol

1. Could we make ImageRef also a dataclass?

I am currently working on refactoring Images to change the format so that ImageRef only holds decomposed values, although this has not yet been reflected in this draft PR.

2. Could you elaborate why we need a separate ParsedImageStr?

ParsedImageStr is a type created to store the parsed form of the canonical image without the project for now, but I plan to remove it if it is no longer needed after the refactoring is completed.

[jopemachine]

We need to fix the CI that is currently broken after the PR below is merged.
#2643