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

Add information about beach-head services #42

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mestadler
Copy link

Initial PR for the servicetemplate usage guide.

@DinaBelova
Copy link
Collaborator

@mestadler can you please

  1. share what's the status of this PR? Afair this was not in final stage yet, we discussed it with you and @wahabmk - are there any changes since that time? I do not see them in the commits, so maybe it was not yet updates, correct?
  2. as a suggestion - can you also please extend quick start guide section in a form of separate commit in PR? Will be nice to have section w/ kyverno or nginx installation in quickstart

@wahabmk
Copy link

wahabmk commented Dec 12, 2024

I re-organized some of the information already existing in this PR + more info into the following:

  1. deploy-services-managedcluster.md: Shows how beach-head services can be deployed with a ManagedCluster object.
  2. create-multiclusterservice.md: Shows how beach-head services can be deployed with a MultiClusterService object. Some portions are shared with ManagedCluster, so those portions refer to the deploy-services-managedcluster.md page.
  3. Some additional information about ServiceTemplate in other sections of the docs as appropriate.

I think this is a good start for now for information on beach-head services.

@wahabmk wahabmk self-assigned this Dec 12, 2024
@wahabmk wahabmk changed the title Create servicetemplate_usage_guide.md Add information about beach-head services Dec 12, 2024
@wahabmk
Copy link

wahabmk commented Dec 12, 2024

@jjainschigg-r Feel free to add Nick Chase as well, I couldn't find his github handle.

Comment on lines +83 to +87
### Verify 2A templates have been successfully reconciled

For additional verification, check that the example templates packaged with 2A have
been installed and are valid.

Copy link
Contributor

@BROngineer BROngineer Dec 20, 2024

Choose a reason for hiding this comment

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

I'd describe the naming convention for templates we use: template-name-sem-ver-with-dashes, replace concrete versions in provided outputs by X-Y-Z, like cluster-api-X-Y-Z, add separate pages for predefined templates:

where actual versions will be listed. And add references to them, like:

The output should be like the following:

NAME                                 VALID
cluster-api-X-Y-Z                    true
cluster-api-provider-aws-X-Y-Z       true
cluster-api-provider-azure-X-Y-Z     true
cluster-api-provider-vsphere-X-Y-Z   true
hmc-X-Y-Z                            true
k0smotron-X-Y-Z                      true
projectsveltos-X-Y-Z                 true

The actual list of pre-defined templates with versions could be found {link to corresponding file}

I believe it will simplify keeping documentation accurate in the future (for instance cluster template versions example is already outdated).

Comment on lines +132 to +133
1. ManagedCluster `dev-cluster-1` would lose and its ingress-nginx (v4.11.3) would be deployed on its cluster.
2. ManagedCluster `dev-cluster-2` would win and ingress-nginx (v4.11.0) would be deployed on its cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd reword it as:

  1. MultiClusterService "global-ingress" will take precedence over ManagedCluster "dev-cluster-1" and ingress-nginx (v4.11.3) defined in MultiClusterService object will be deployed on the cluster.
  2. ManagedCluster "dev-cluster-2" will take precedence over MultiClusterService "global-ingress" and ingress-nginx (v4.11.0) defined in ManagedCluster object will be deployed on the cluster.

Comment on lines +124 to +131
values: |
victoriametrics:
vmauth:
ingress:
host: vmauth.hmc0.example.net
credentials:
username: motel
password: motel
Copy link
Contributor

Choose a reason for hiding this comment

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

Does not related to documentation itself, but need to be fixed asap. Issue: Mirantis/hmc#817

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Write documentation for service templates in official docs
4 participants