arlon
arlon copied to clipboard
Separate Tutorial document that emphasizes the declarative deployment example (examples/declarative)
We should add it to the tutorial if there's still one. In particular, the following commands:
-
kubectl apply -f examples/declarative
for creating app, appprofile, and workload cluster -
kubectl delete -f examples/declarative
for cleaning up
Aha! Link: https://pf9.aha.io/features/ARLON-378
The guide does mention it at the end of installation guide. https://arlonproj.github.io/arlon/0.10/installation/ Are there any other sections that need to mention declarative examples as well?
Hey team! Please add your planning poker estimate with Zenhub @bcle @jayanth-tjvrr @Rohitrajak1807 @ShaunakJoshi1407
Hey team! Please add your planning poker estimate with Zenhub @bcle @jayanth-tjvrr @Rohitrajak1807 @ShaunakJoshi1407
It'll be wise to wait for a response on https://github.com/arlonproj/arlon/issues/418#issuecomment-1378384971
The guide does mention it at the end of installation guide. https://arlonproj.github.io/arlon/0.10/installation/ Are there any other sections that need to mention declarative examples as well?
I see. Ok, it's not intuitive because it's buried at the end of Installation. I didn't realize we didn't have a dedicated Tutorial article. I propose to change this issue to separate the tutorial from the installation, and emphasize the declarative deployment. The tutorial can be very short.

The guide does mention it at the end of installation guide. https://arlonproj.github.io/arlon/0.10/installation/ Are there any other sections that need to mention declarative examples as well?
Examples for creation of profiles and apps should be in the tutorial and not in the installation page, right?
I see the 2 tutorials now, one for gen1 clusters and one for gen2 clusters. But the gen2 cluster tutorial uses gen1 profiles. I think we need just one Tutorial article that demoes all the latest features of the current release, and in an easy-to-use manner. This means combining gen2 clusters with AppProfiles and Apps. The declarative example would be great for that. Cluster overrides should also be included, but as we know, we currently can't include that in the declarative example yet due to #416, but the tutorial can still describe it independently.
I see the 2 tutorials now, one for gen1 clusters and one for gen2 clusters. But the gen2 cluster tutorial uses gen1 profiles. I think we need just one Tutorial article that demoes all the latest features of the current release, and in an easy-to-use manner. This means combining gen2 clusters with AppProfiles and Apps. The declarative example would be great for that. Cluster overrides should also be included, but as we know, we currently can't include that in the declarative example yet due to #416, but the tutorial can still describe it independently.
We'll also need to find a way to support CAS with the new apps and app-profiles. This will need some manual validation, and at worst some code change too. #424 discusses removing the current profiles and bundles code, I think critical features like CAS should be validated before removing them.
We should add it to the tutorial if there's still one. In particular, the following commands:
kubectl apply -f examples/declarative
for creating app, appprofile, and workload clusterkubectl delete -f examples/declarative
for cleaning upAha! Link: https://pf9.aha.io/features/ARLON-378
@bcle the kubectl delete
command might be a bit of trouble because of CAPA bugs. 🤔
For the delete bug, I'm considering updating the example to use kubeadm (control plane and nodes) instead. It's the most mature provider and I've experienced reliable delete semantics in the past.
I see the 2 tutorials now, one for gen1 clusters and one for gen2 clusters. But the gen2 cluster tutorial uses gen1 profiles. I think we need just one Tutorial article that demoes all the latest features of the current release, and in an easy-to-use manner. This means combining gen2 clusters with AppProfiles and Apps. The declarative example would be great for that. Cluster overrides should also be included, but as we know, we currently can't include that in the declarative example yet due to #416, but the tutorial can still describe it independently.
The index in docs page contains a link to gen2 tutorial only. https://arlonproj.github.io/arlon/0.10/gen2_Tutorial/ Yes, it needs cleaning up to emphasize/ describe only gen2 features.
This tutorial can include a link to a gen-1 tutorial
that contains the deprecated commands. We can then exclude the deprecated/ obsolete syntax from the (gen-2) tutorial.