docs: update Install section in README#794
Conversation
|
@NucleoFusion I wasn't sure about the security section can you check it and see if any more changes are required |
| #### APT repository | ||
|
|
||
| APT based installation is available via the project's gh-pages branch. Refer to the repository for more details. |
There was a problem hiding this comment.
You need to add this
Refer to the .dagger/apt.go file for how.
There was a problem hiding this comment.
No I meant explain the actual installation for apt
Which you can go see how in the .dagger/apt.go
I am not exactly sure for the command itself but you can ask AI or something.
It will go like, adding harbor-cli repo or something to trusted. And then apt install harbor-cli
| @@ -92,6 +92,8 @@ brew install harbor-cli | |||
|
|
|||
| Otherwise, you can download the binary from the [releases page](https://github.com/goharbor/harbor-cli/releases). | |||
There was a problem hiding this comment.
I would keep this in the installation.md as well, and only have the 'refer to xxx' in the readme.md
There was a problem hiding this comment.
I didn't remove the installation through homebrew i think it is best to keep it here but i moved the container configuration in install.md
|
|
||
| ## Security | ||
|
|
||
| Harbor CLI provides security features such as SBOM (Software Bill of Materials) and Cosign support for verifying artifacts. These help ensure the integrity and authenticity of distributed binaries. |
There was a problem hiding this comment.
I would explain more
That harbor-cli provides attested binaries and images.
Via the Cosign, Checksum.
And also provides downloadable SBOM following the Dynamo format or something for each binary
|
@NucleoFusion Please review the changes |
|
Lets discuss in the next meet how we want to re-structure the readme for the growing installation section |
| source ~/.zshrc # or restart your terminal | ||
| ``` | ||
|
|
||
| ## Linux, macOS and Windows |
There was a problem hiding this comment.
brew doesnt support windows idts
So you could also remove Windows from here anyway
|
After discussing in the meeting with other maintainers as well. The implementation should show only the main install parts in the README which are:-
And the rest of the install methods in the INSTALL.md |
ba94602 to
423af49
Compare
|
@NucleoFusion I have done all the changes and kept only brew and image install in readme, updated the security and apt installaton part too. Please review |
| #### APT repository | ||
|
|
||
| APT based installation is available via the project's gh-pages branch. Refer to the repository for more details. |
There was a problem hiding this comment.
No I meant explain the actual installation for apt
Which you can go see how in the .dagger/apt.go
I am not exactly sure for the command itself but you can ask AI or something.
It will go like, adding harbor-cli repo or something to trusted. And then apt install harbor-cli
|
I have done the changes @NucleoFusion |
| ```bash | ||
| echo "deb [trusted=yes] https://goharbor.github.io/harbor-cli/buildDirs/stable /" | sudo tee /etc/apt/sources.list.d/harbor-cli.list | ||
| ``` | ||
|
|
||
| 2. Update package index: | ||
|
|
||
| ```bash | ||
| sudo apt update | ||
| ``` | ||
|
|
||
| 3. Install Harbor CLI: | ||
|
|
||
| ```bash | ||
| sudo apt install harbor-cli | ||
| ``` |
There was a problem hiding this comment.
This doesnt work rn due to some error in serving the apt.
Please hold on while we try to fix it.
There was a problem hiding this comment.
@NucleoFusion Any updates on the apt issue
There was a problem hiding this comment.
Yes,but it's still not fully implemented, might take a week or two more
|
Apt is done now, please refer to #790 For containerized enviroments |
|
Also, put the installation in the readme, we dont want a 2nd file |
|
@adityashekhawat1999 any update? |
4c99570 to
c6fd3b1
Compare
Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
c6fd3b1 to
14643cd
Compare
|
@NucleoFusion Please check if any more changes are required |
Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
Signed-off-by: Aditya Pratap Singh Shekhawat <adityashekhawat@Adityas-MacBook-Air.local>
Description
This PR improves the installation documentation by adding a dedicated INSTALL.md file and expanding the available installation methods.
Type of Change
Changes