diff --git a/backstage-resources/docs/onboarding/additional-infos.md b/backstage-resources/docs/onboarding/additional-infos.md index 59fb9926..755bec2a 100644 --- a/backstage-resources/docs/onboarding/additional-infos.md +++ b/backstage-resources/docs/onboarding/additional-infos.md @@ -8,7 +8,7 @@ Here we want to give you a good overview how this approach works and what platfo ## Overview - Onboarding teams and apps with ApplicationSets -![image](img/onboarding-teams-with-appset.png) +![image](../img/onboarding-teams-with-appset.png) While this picture seems to be complex, it actually shows that onboarding teams and apps is just as easy as follows: @@ -26,7 +26,7 @@ The internal operators, controllers and a little bit of love and magic then ## Overview - Onboarding teams and apps with App-Of-Apps -![image](img/onboarding-teams-with-appofapps.png) +![image](../img/onboarding-teams-with-appofapps.png) Also this picture is probably a little bit overwhelming in the first place, but in the end there is just one additional step here diff --git a/backstage-resources/docs/onboarding/onboarding-apps.md b/backstage-resources/docs/onboarding/onboarding-apps.md index 6964da5d..24826643 100644 --- a/backstage-resources/docs/onboarding/onboarding-apps.md +++ b/backstage-resources/docs/onboarding/onboarding-apps.md @@ -11,41 +11,41 @@ For Showcase-Purposes there is an AppSet for "Multi-Stage Apps with Kargo-Pipeli With the scaffolder [template for multi-stage app with kargo pipeline](https://backstage.demo.kubrix.cloud/create/templates/default/multi-stage-app-with-kargo-pipeline) you can automatically create such a repo with the predefined example application 'podtato-head'. -![image](img/app-onboarding-1.png) +![image](../img/app-onboarding-1.png) Just specifiy your application name and a description and be sure that the "FQDN" points to `demo.kubrix.cloud`. Then click 'Next'. -![image](img/app-onboarding-2.png) +![image](../img/app-onboarding-2.png) The Git-Repo for your applications Kubernetes resources is automatically set, just click 'Next'. -![image](img/app-onboarding-3.png) +![image](../img/app-onboarding-3.png) On the summary page review your data and click on 'Create' -![image](img/app-onboarding-4.png) +![image](../img/app-onboarding-4.png) Backstage now creates a new Git-Repo with the needed Helm-Chart in it and registers this new app in backstage. With 'Repository' you can open the Git-Repository and with 'Open in catalog' you will open the corresponding application component in backstage. -![image](img/app-onboarding-5.png) +![image](../img/app-onboarding-5.png) In the backstage component overview of your application you can see the ArgoCD sync and health status. It may take a few seconds until your app is recognized bei the ArgoCD ApplicationSet and synced in ArgoCD. You can click on the application name to open the corresponding argocd dashboard. -![image](img/app-onboarding-6.png) +![image](../img/app-onboarding-6.png) On the bottom of the component overview page you can see that this application has three subcomponents, one per stage. You can click on each subcomponent and get to the overview page of each subcomponent. -![image](img/app-onboarding-7.png) +![image](../img/app-onboarding-7.png) Each component page has different tabs for different informations. -![image](img/app-onboarding-8.png) +![image](../img/app-onboarding-8.png) * Overview: some key informations for your app from different tools and links to e.g. interesting Grafana Dashboards * Kargo: GitOps-Promotion tool to bring your changes from dev to prod (Password in demo env: 'admin') -![image](img/app-onboarding-10.png) +![image](../img/app-onboarding-10.png) * Kubernetes: shows your app specific resources and state in your Kubernetes cluster * Docs: shows your application documentation @@ -54,13 +54,13 @@ Each component page has different tabs for different informations. * Github Insights: overview of your application gitops-Repo * Grafana Dashboard: overview of your application resource consumption and health state (User: admin, Password: prom-operator) -![image](img/app-onboarding-12.png) +![image](../img/app-onboarding-12.png) And at the bottom of your components overview page, you see the ArgoCD status and a link to open your application. -![image](img/app-onboarding-9.png) +![image](../img/app-onboarding-9.png) -![image](img/app-onboarding-11.png) +![image](../img/app-onboarding-11.png) # New apps via Team-App-Of-Apps Repo diff --git a/backstage-resources/docs/onboarding/onboarding-teams.md b/backstage-resources/docs/onboarding/onboarding-teams.md index 61bdd9eb..77b0d52d 100644 --- a/backstage-resources/docs/onboarding/onboarding-teams.md +++ b/backstage-resources/docs/onboarding/onboarding-teams.md @@ -2,25 +2,25 @@ New teams can simply onboard themselves by [executing the 'team-onboarding' template](https://backstage.demo.kubrix.cloud/create/templates/default/team-onboarding) or by clicking "Choose" in the "Team-Onboarding" template here: https://backstage.demo.kubrix.cloud/create -![image](img/team-onboarding-1.png) +![image](../img/team-onboarding-1.png) The team name is automatically selected based on your assigned group, so just click on 'Next' -![image](img/team-onboarding-2.png) +![image](../img/team-onboarding-2.png) The host, organization and path to your kubriX platform Git-Repo is also automatically select, so just click on 'Next' -![image](img/team-onboarding-3.png) +![image](../img/team-onboarding-3.png) On the summary page review your data and click on 'Create' -![image](img/team-onboarding-4.png) +![image](../img/team-onboarding-4.png) Backstage creates a Pull-Request for you to add your team to the team-onboarding chart. This PR needs to get reviewewd and merged by the platform-team. Also, your team gets their own "App-Of-apps" Git-Repo where you can put your own ArgoCD application definitions in the created 'demo-apps' folder. -![image](img/team-onboarding-5.png) +![image](../img/team-onboarding-5.png) What you will see in the Pull-Request 'Files changed" tab, is a new stanza for your team. With these values the team-onboarding chart creates: diff --git a/backstage-resources/docs/onboarding/promoting-changes.md b/backstage-resources/docs/onboarding/promoting-changes.md index 4eec8095..7af0cf71 100644 --- a/backstage-resources/docs/onboarding/promoting-changes.md +++ b/backstage-resources/docs/onboarding/promoting-changes.md @@ -2,29 +2,29 @@ When you want to make changes to your applications Kubernetes resources you can simply click "View sources" on your components overview page. Use the "umbrella" application and not the stage specific application for this! -![image](img/app-changing-and-promoting-app-1.png) +![image](../img/app-changing-and-promoting-app-1.png) In our showcase we change the value in our values.yaml .hat.env[0].value to "03" and commit the change to main Branch, which will change the podtato heads hat! -![image](img/app-changing-and-promoting-app-2.png) +![image](../img/app-changing-and-promoting-app-2.png) In your "Kargo" tab you will see this new commit in the "Freight timeline" automatically or you need to click "Refresh" on your "Warehouse". -![image](img/app-changing-and-promoting-app-3.png) +![image](../img/app-changing-and-promoting-app-3.png) When you click on the "Promote" button on the left side of the "test" box and then click on the new "freight" you we see the question "Are you sure you want to promote test". Answer with "yes". -![image](img/app-changing-and-promoting-app-4.png) +![image](../img/app-changing-and-promoting-app-4.png) Then this new commit will get promoted to your "test" branch and the "test" ArgoCD app will get synchronized. -![image](img/app-changing-and-promoting-app-5.png) +![image](../img/app-changing-and-promoting-app-5.png) During promotion several quality gates could be implemented to be sure your new version is also working. In this way you can promote your changes to the production system and you will see that the hat changes to a nice pirate cap. -![image](img/app-changing-and-promoting-app-6.png) +![image](../img/app-changing-and-promoting-app-6.png)