Skip to content

doc: Registering calico-windows-v3.17.1 #529

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

Merged
AbelHu merged 1 commit into from
Jan 26, 2021
Merged

doc: Registering calico-windows-v3.17.1 #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,13 @@ provided by the bot. You will only need to do this once across all repos using o
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

# CGManifest File
A cgmanifest file is a json file used to register components manually when the component type is not supported by governance. The file name is "cgmanifest.json" and you can have as many as you need and can be anywhere in your repository.

File path: `./vhdbuilder/cgmanifest.json`

Reference: https://docs.opensource.microsoft.com/tools/cg/cgmanifest.html

Package:
- Calico Windows: https://docs.projectcalico.org/release-notes/
15 changes: 15 additions & 0 deletions vhdbuilder/cgmanifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"Registrations": [
{
"Component": {
"Type": "other",
"Other": {
"Name": "CalicoWindows",
Copy link
Copy Markdown
Member

@mainred mainred Jan 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. how should we relate the CalicoWindows to the calico component we are using?
  2. how can we verify its correctness? is this tool useful? https://docs.opensource.microsoft.com/tools/cg/cgmanifest.html#how-can-i-test-my-cgmanifestjson-file cgmanifest.json

Copy link
Copy Markdown
Member Author

@AbelHu AbelHu Jan 13, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For #1, can you add more details for your question? From my understanding, it is just a name. The source URL is more important.
For #2, when creating this PR with this file cgmanifest.json, the reviewer microsoftopensource is automatically recommended so I think that it should be good. And I will wait the review from Microsoft opensource team. It seems like building the tool needs more time. We can do it later if it is worth.

Copy link
Copy Markdown

@jcfiorenzano jcfiorenzano Jan 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi I work in the Open Source Engineering team

  1. In the case of "other" components as @AbelHu mention the most important part is the URL, think about the name as the display name.
  2. The cgmanifest looks good to me, but you can use to tool to validate that the file is going to be parsed successfully by our detectors.

Copy link
Copy Markdown
Member Author

@AbelHu AbelHu Jan 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jcfiorenzano Thanks for your review. We will follow the guidance to merge the PR and then check the alerts.

Copy link
Copy Markdown
Member

@mainred mainred Apr 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jcfiorenzano may I ask do we need to update the version and DownloadUrl every time we have an update of this component? thanks

"Version": "3.17.1",
"DownloadUrl": "https://acs-mirror.azureedge.net/calico-node/v3.17.1/binaries/calico-windows-v3.17.1.zip"
}
},
"DevelopmentDependency": false
}
]
}