arlon icon indicating copy to clipboard operation
arlon copied to clipboard

Separate Tutorial document that emphasizes the declarative deployment example (examples/declarative)

Open bcle opened this issue 2 years ago • 11 comments

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

bcle avatar Jan 11 '23 01:01 bcle

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?

Rohitrajak1807 avatar Jan 11 '23 08:01 Rohitrajak1807

Hey team! Please add your planning poker estimate with Zenhub @bcle @jayanth-tjvrr @Rohitrajak1807 @ShaunakJoshi1407

cruizen avatar Jan 12 '23 16:01 cruizen

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

Rohitrajak1807 avatar Jan 12 '23 16:01 Rohitrajak1807

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.

bcle avatar Jan 12 '23 16:01 bcle

image We have separate pages for installation and tutorial. The link for tutorial is https://arlonproj.github.io/arlon/0.10/gen2_Tutorial/

cruizen avatar Jan 12 '23 20:01 cruizen

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?

cruizen avatar Jan 12 '23 20:01 cruizen

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.

bcle avatar Jan 12 '23 23:01 bcle

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.

Rohitrajak1807 avatar Jan 17 '23 05:01 Rohitrajak1807

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

@bcle the kubectl delete command might be a bit of trouble because of CAPA bugs. 🤔

Rohitrajak1807 avatar Jan 17 '23 05:01 Rohitrajak1807

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.

bcle avatar Jan 17 '23 19:01 bcle

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.

cruizen avatar Jan 19 '23 11:01 cruizen