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.

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

docs: Update about dependency handling of Helm Charts w/signoff #10998

Closed
wants to merge 6 commits into from

Conversation

Jougan-0
Copy link
Contributor

@Jougan-0 Jougan-0 commented May 19, 2024

Notes for Reviewers

This PR fixes #10979

  • Auto deployment of CRDs/controllers update
  • Dependency Detection and Resolution

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Jougan-0 <prasantmishra2018@gmail.com>
@github-actions github-actions bot added the area/docs Documentation update needed label May 19, 2024
@Jougan-0 Jougan-0 requested a review from leecalcote May 19, 2024 00:44
@l5io
Copy link
Collaborator

l5io commented May 19, 2024

Copy link

github-actions bot commented May 19, 2024

@Jougan-0
Copy link
Contributor Author

Direct Link to preview

<h4>5. Provisioning</h4>
<p>A Directed Acyclic Graph (DAG) generated in the previous step is processed. Dependent components are processed sequentially, while others are processed in parallel. Meshery intelligently handles the deployment order to ensure successful deployment.</p>
</details>

<h3>Auto-Deployment of CRDs and Operators</h3>

Meshery automates the deployment of Custom Resource Definitions (CRDs) and operators based on the source from which a particular component was registered. Currently, by default Meshery automatically deploys components that are sourced from Artifact Hub (utilizing Helm Charts). (_Support for OCI registries is expected in the near future._)
Meshery automates the deployment of Custom Resource Definitions (CRDs) and operators based on the source from which a particular component was registered. When a deployment request is made for a HelmChart without the upgrade flag, Meshery does not check for the existence of the HelmChart and always tries to install it. In cases where the chart/release already exists, the installation fails (from the Helm side), and Meshery errors out. Currently, by default, Meshery automatically deploys components that are sourced from Artifact Hub (utilizing Helm Charts). (_Support for OCI registries is expected in the near future._)
Copy link
Member

Choose a reason for hiding this comment

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

An explanation about default behavior and how to control it is missing. @MUzairS15

Copy link
Member

Choose a reason for hiding this comment

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

@MUzairS15, also, when will the deployment modal have a checkbox for installing necessary dependencies?

Copy link
Contributor

Choose a reason for hiding this comment

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

The default behaviour is to try install w/o checking for existence of a release.

Currently, the control is missing. I will add it along with exposing the checkbox for installing dependencies (taking it now).

Copy link
Contributor

Choose a reason for hiding this comment

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

@Jougan-0 will you update the PR to include the above behaviour described in the comment? I have a open PR for the implementation

Copy link
Contributor Author

@Jougan-0 Jougan-0 May 31, 2024

Choose a reason for hiding this comment

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

Yah, sure I need to add

The default behaviour is to try install w/o checking for existence of a release.
I will add it along with exposing the checkbox for installing dependencies 

explaining this part may you please reference me the pr link.

Copy link
Member

Choose a reason for hiding this comment

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

P.S. We use English here.

Signed-off-by: Jougan-0 <prasantmishra2018@gmail.com>
@l5io
Copy link
Collaborator

l5io commented May 31, 2024

@l5io
Copy link
Collaborator

l5io commented Jun 5, 2024

Signed-off-by: Jougan-0 <prasantmishra2018@gmail.com>
@l5io
Copy link
Collaborator

l5io commented Jun 5, 2024

Signed-off-by: Shlok Mishra <99207534+Jougan-0@users.noreply.github.com>
@l5io
Copy link
Collaborator

l5io commented Jun 7, 2024

<h4>5. Provisioning</h4>
<p>A Directed Acyclic Graph (DAG) generated in the previous step is processed. Dependent components are processed sequentially, while others are processed in parallel. Meshery intelligently handles the deployment order to ensure successful deployment.</p>
</details>

<h3>Auto-Deployment of CRDs and Operators</h3>
Meshery automates the deployment of Custom Resource Definitions (CRDs) and operators based on the source from which a particular component was registered. When a deployment request is made for a Helm Chart without the upgrade flag, Meshery does not check for the existence of the Helm Chart and always tries to install it. In cases where the chart/release already exists, the installation fails (from the Helm side), and Meshery errors out. Currently, by default, Meshery automatically deploys components that are sourced from Artifact Hub (utilizing Helm Charts).
Copy link
Contributor

Choose a reason for hiding this comment

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

Deployment request made for Helm chart?
It happens only when users deploy helm chart (No)
Make it clear, it is confusing.


Meshery automates the deployment of Custom Resource Definitions (CRDs) and operators based on the source from which a particular component was registered. Currently, by default Meshery automatically deploys components that are sourced from Artifact Hub (utilizing Helm Charts). (_Support for OCI registries is expected in the near future._)

Meshery gives users control over installing dependencies through a simple checkbox option. Users can decide whether to install dependencies during deployment. By default, Meshery tries to install dependencies without checking for an existing release, making deployment quicker. (Support for OCI registries is coming soon.)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Meshery gives users control over installing dependencies through a simple checkbox option. Users can decide whether to install dependencies during deployment. By default, Meshery tries to install dependencies without checking for an existing release, making deployment quicker. (Support for OCI registries is coming soon.)

what is the relevance of this statement here? You updated the paragraph so do it in entirety.

Where we talk about helm chart registries add there.


**A:** Meshery determines the source based on the metadata of models and components. This metadata includes the actual location of the components, whether it's a Helm chart, Kubernetes manifests, or any other format. Depending on the type of source (Helm chart or Kubernetes manifest), Meshery deploys the components accordingly.

**Q: How does Meshery know what Operator to provision when provisioning components from a given Model?**
Copy link
Contributor

Choose a reason for hiding this comment

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

There isn’t a difference on how Meshery determines dependent CRDs and operators.

@Jougan-0 Jougan-0 closed this Jun 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Infrastructure Lifecycle: Manner of dependency deployment
4 participants