docs: add ModelPack to Harbor push guide with modctl#72
docs: add ModelPack to Harbor push guide with modctl#72leopardx602 wants to merge 1 commit intomainfrom
Conversation
Complete documentation for packaging models as OCI artifacts and pushing to Harbor registry, including Robot Account setup, Docker configuration, and troubleshooting.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation guide for packaging and pushing ModelPacks to Harbor using modctl. Feedback focuses on improving the visual presentation by utilizing Starlight components like <Steps> and <Aside>, clarifying Docker configuration file locations, and ensuring consistent project naming across all examples.
| 1. In the **OtterScale** UI, locate the left-side navigation bar. | ||
| 2. Click **Registry**. | ||
| 3. You will be redirected to the Harbor UI associated with your OtterScale environment. |
There was a problem hiding this comment.
Since the Steps component is already imported, it should be used to wrap numbered lists to provide a better visual representation of the workflow in the Starlight theme. This should also be applied to other multi-step lists in the document.
<Steps>
1. In the **OtterScale** UI, locate the left-side navigation bar.
2. Click **Registry**.
3. You will be redirected to the Harbor UI associated with your OtterScale environment.
</Steps>
| 2. Click **Registry**. | ||
| 3. You will be redirected to the Harbor UI associated with your OtterScale environment. | ||
|
|
||
| > OtterScale uses Harbor as its OCI registry for storing model artifacts such as ModelPack. |
There was a problem hiding this comment.
Use the <Aside> component instead of a standard blockquote for better visual integration and to match the existing imports.
<Aside type="note">
OtterScale uses Harbor as its OCI registry for storing model artifacts such as ModelPack.
</Aside>
| - **Username** (for example: `robot$my_project+modctl-pusher`) | ||
| - **Token (Password)** | ||
|
|
||
| > ⚠️ The token is shown only once. Make sure to copy and store it securely. |
There was a problem hiding this comment.
This security warning is important. Using <Aside type="caution"> will make it much more prominent and consistent with the documentation style. The emoji can be removed as the component provides its own icon.
<Aside type="caution">
The token is shown only once. Make sure to copy and store it securely.
</Aside>
|
|
||
| ### Note for HTTP Harbor Registries | ||
|
|
||
| If your Harbor registry is **HTTP-only**, ensure it is configured as an insecure registry in Docker: |
There was a problem hiding this comment.
It is helpful to specify that this configuration belongs in the Docker daemon.json file and mention its typical location (e.g., /etc/docker/daemon.json on Linux or via Docker Desktop settings).
| ### Example | ||
|
|
||
| ```bash | ||
| modctl build -t 127.0.0.1:32180/my_projects/my_project001:0.1.0 . |
There was a problem hiding this comment.
The project name my_projects/my_project001 is inconsistent with the robot account example my_project used in Step 3. Using a consistent project name like my_project/my-model throughout the guide prevents confusion.
modctl build -t 127.0.0.1:32180/my_project/my-model:0.1.0 .
| ### Example | ||
|
|
||
| ```bash | ||
| modctl push 127.0.0.1:32180/my_projects/my_project001:0.1.0 |
There was a problem hiding this comment.
Update this example to match the project name used in the previous steps for consistency.
modctl push 127.0.0.1:32180/my_project/my-model:0.1.0
| If your Harbor registry uses HTTP, include: | ||
|
|
||
| ```bash | ||
| modctl push --plain-http 127.0.0.1:32180/my_projects/my_project001:0.1.0 |
There was a problem hiding this comment.
Update this example to match the project name used in the previous steps for consistency.
modctl push --plain-http 127.0.0.1:32180/my_project/my-model:0.1.0
1 participant
Complete documentation for packaging models as OCI artifacts and pushing to Harbor registry, including Robot Account setup, Docker configuration, and troubleshooting.