Skip to content
This repository has been archived by the owner on Jul 28, 2023. It is now read-only.

Provide a Day2 Ops experience for microservices (define, observe, manage) using kAppNav open source #70

Closed
4 of 8 tasks
barecode opened this issue Sep 17, 2019 · 23 comments
Assignees
Labels
documentation-id Improvements or additions to documentation Epic status-Green

Comments

@barecode
Copy link

barecode commented Sep 17, 2019

Include the kAppNav open source project to be installed by Kabanero, and exposed as part of the Kabanero experience within OKD console. The user experience cannot just be a be a "big of bits" but rather integrated with the full Kabanero experience.

Some high-level TODOs which are necessary for this epic to be resolved:

  • Include kAppNav to kabanero.io site experience. This requires...
    • a logo icon on the site
    • an introduction blog (@barecode)
    • a how-to guide (@cvignola)
    • an end-to-end video to demonstrate use of kAppNav within Kabanero
  • Include kAppNav to kabanero install operator
  • Include kAppNav to kabanero UI experience
  • Include pointers from kabanero documentation to kAppNav documentation (GH pages or similar)
@barecode barecode changed the title Include kAppNav to kabanero.io install experience Define, observe and manage microservices with kAppNav. Sep 17, 2019
@barecode
Copy link
Author

Related Issues:
kabanero-io/kabanero-operator#116

@barecode barecode changed the title Define, observe and manage microservices with kAppNav. Expand the Day 2 operations experience for microservices with an application centric view that allows the user to Define, observe and manage microservice applications. Sep 17, 2019
@barecode barecode changed the title Expand the Day 2 operations experience for microservices with an application centric view that allows the user to Define, observe and manage microservice applications. Expand the Day 2 operations experience for microservices with an application centric view that allows the user to define, observe and manage microservice applications (with kAppNav). Sep 17, 2019
@barecode barecode changed the title Expand the Day 2 operations experience for microservices with an application centric view that allows the user to define, observe and manage microservice applications (with kAppNav). Provide a Day2 Ops experience for microservices (define, observce, manage) using kAppNav open source Sep 17, 2019
@barecode barecode self-assigned this Sep 18, 2019
@marikaj123
Copy link
Member

@dianak2016 - can a release be assigned to the Epic?

@dianak2016 dianak2016 changed the title Provide a Day2 Ops experience for microservices (define, observce, manage) using kAppNav open source Provide a Day2 Ops experience for microservices (define, observe, manage) using kAppNav open source Sep 19, 2019
@stephenkinder stephenkinder added the documentation-id Improvements or additions to documentation label Oct 3, 2019
@marikaj123 marikaj123 added ID Required Need to involve the ID team and removed ID Required Need to involve the ID team labels Oct 3, 2019
@mtamboli
Copy link

mtamboli commented Oct 4, 2019

Would like to get scope of this feature. Would this be installed by default with kabanero? How would this feature help Jane/Todd/Champ - high level use cases?

@marikaj123
Copy link
Member

@barecode and @stevekinder-ibm - who can provide the details required by SVT?

@cvignola
Copy link

cvignola commented Oct 8, 2019

@mtamboli Kabanero 0.2.x optionally installs kAppNav (you have to answer 'y' when asked) while running the install script. @kaczyns please keep me honest.

@barecode said he would provide scenarios. I would say at minimum:

  1. install Kabanero, including kAppNav
  2. deploy an application
  3. open kAppNav UI and see application and its components

@mtamboli I can work with you on step 2 to ensure that step 3 is possible. I need to know more about how you are creating/deploying your application in order to do so. Please contact me when you are ready. Thanks

@mtamboli
Copy link

mtamboli commented Oct 8, 2019

@cvignola We will be using appsody operator installed with kabanero to deploy application. Will get in touch with you.

@alohr51
Copy link
Member

alohr51 commented Oct 8, 2019

@cvignola for your first point about installing kAppNav - that was the original function, but it was changed to not install by default (to avoid reads breaking current automation flows)

You'll have to set env var ENABLE_KAPPNAV to yes before running the install script to install it. https://github.com/kabanero-io/kabanero-foundation/blob/master/scripts/install-kabanero-foundation.sh#L13

@stephenkinder
Copy link
Member

@cvignola So SVT should be using the Kabanero pipelines. The pipeline template is here: https://github.com/kabanero-io/kabanero-pipelines/blob/master/pipelines/incubator/deploy-task.yaml ... you can see it just applies the Appsody app-deploy.yaml. The Kabanero operator has configured the Appsody operator to watch for CRDs in the targetNameSpace list.

@barecode
Copy link
Author

barecode commented Oct 9, 2019

Here are the SVT scenarios and general GA release acceptance criteria:

  1. kAppNav can be installed as part of the Kabanero install flow (as per Tim's earlier comment, this requires you to set the ENABLE_KAPPNAV=yes environment variable)
  2. kAppNav should also be separately installable using the kAppNav operator, following the instructions available from https://kappnav.io/ (please let us know if the installation steps are not sufficiently clear)
  3. Once installed, kAppNav's icon should be visible from the OKD cataloge/service console. Given no applications will likely have been installed, no applications should be visible in the kAppNav GUI.
  4. Once an application is built and deployed using Kabanero, the application (and its components) should be visible in the kAppNav GUI.
  5. The Application visible in kAppNav should allow you to navigate around and inspect and discover the various components which comprise the application.

@marikaj123
Copy link
Member

marikaj123 commented Oct 10, 2019

SVT team is looking after testing this Epic and cover as many scenarios as they can.

@barecode
Copy link
Author

Re: inclusion into kabanero.io, the kappnav people have some thoughts on how that might be done:
kappnav/issues#40

@marikaj123
Copy link
Member

marikaj123 commented Oct 16, 2019

@cvignola and @barecode - are we going to deliver the child issue 'Introduce KnappNav in kabanero.io' in release v0.2?

@alohr51
Copy link
Member

alohr51 commented Oct 16, 2019

@marikaj123 you should make that comment inside the issue you are referring to.

@barecode
Copy link
Author

This epic remains open until we deliver the Guide on Kabanero.io. I am not sure what the Issue is right now to link it though.

@alohr51
Copy link
Member

alohr51 commented Oct 24, 2019

@barecode if the guide is complete then the ID team needs to review it first, then Alan Little & Nate Ziemann need to do a final review to approve it, then it can get linked on kabanero.io

@marikaj123
Copy link
Member

kAppNav guide for kabanero.io is complete. Next step is waiting for Nate/Alan signoff and then actual publish. Richard Walls is handling that review.

@marikaj123
Copy link
Member

Work will continue in the next release

@marikaj123
Copy link
Member

@cvignola - Pipeline to use Appsody build to get kAppNav labels generated.

@marikaj123
Copy link
Member

According to Chris, The guide is published. The logo, blog, and video are still in the backlog and candidates for 0.4.0

@marikaj123
Copy link
Member

marikaj123 commented Dec 2, 2019

Needs pipeline to complete the bug fix: kabanero-io/kabanero-pipelines#132

@marikaj123
Copy link
Member

@cvignola - What is the status of video "Create end-to-end video for kAppNav"

@cvignola
Copy link

cvignola commented Dec 5, 2019

The kAppNav guide is published: https://kabanero.io/guide/using-kAppNav/

@marikaj123
Copy link
Member

According to Chris V. the feature wor is complete and can be closed. The video will be complete during this month and will be tracked seperatly.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation-id Improvements or additions to documentation Epic status-Green
Projects
None yet
Development

No branches or pull requests

8 participants