Konveyor and OLM add-ons #711

freschri · 2023-06-03T16:13:51Z

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

shapirov103

@freschri I added some tactical feedback, however on a more strategic items I have a few questions:

https://github.com/konveyor/konveyor.github.io does not appear to be production ready. I don't observe any releases at all and the versioning schema they apply is in the alpha range. In addition the repo does not appear to be actively maintained. Most contributions happened last year and I don't observe active development on it. We will only take actively maintained popular OSS projects here, so it appears that this addon may be best served in your personal github repo for now.
If you have access to the contributors and/or partner sponsoring the OSS then it may be best to move to their repo and we can include some doc updates on it. This PR can be split to just keep the OLM part which is indeed an enabler.
OLM being non-helm addon : how do you envision maintenance of this add-on, e.g. version upgrades and testing against latest EKS versions? Do I have your commitment on ownership of this part?

shapirov103 · 2023-06-16T14:18:53Z

lib/addons/konveyor/tackle-manifest.ytpl

@@ -0,0 +1,39 @@
+kind: Tackle
+apiVersion: tackle.konveyor.io/v1alpha1


v1alpha1 makes me think this product is not production ready.

Hello,

I'm a maintainer of Konveyor and can provide some more context of Konveyor's status.
Konveyor is an actively developed and maintained CNCF sandbox project that is the upstream for Red Hat's Migration Toolkit for Applications .

The code is in production at multiple large organizations being used to aid modernization engagements of enterprise java applications to Kubernetes. The code that makes up Konveyor began ~10 years ago on the Analysis side with the latest version of the platform being developed ~2 years ago, the solution was called Tackle2.

After being accepted into CNCF, there has been an effort to refocus Konveyor onto a Unified vision of bringing the functionality that used to be in separate projects together into a common solution which is Konveyor.

As part of this refocus, we decided to release Konveyor as a "v0.1" as opposed to continuing with the Tackle 2.1+ scheme that was in place prior.

It is possible for the API surface to change as we are working with the community to shape what the future will be. In regard to the API surface for the operator CR, we are careful to keep upgrades working and stable and have automated tests and QE resources actively helping to ensure stability.

Hello @jwmatthews, thank you for your feedback, it surely helps. Understand the comment related to the CR API version and upgrades. It is not as intuitive but it surely matches the saying "there is nothing more permanent than temporary" when it comes versioning.

I assume we should change the source references to https://github.com/konveyor/tackle2-operator, please confirm.

Is https://konveyor.github.io/ still the right documentation entry point? I saw a reference to tackle document here pointing to what appears to be the right page: https://konveyor.github.io/tackle. This url, however, is not functioning.

Understand that doc maintenance may not be the top priority, I was a lot more interesting in dev activities, which you confirmed. Thank you.

Yes, https://konveyor.github.io/ is the right documentation entry point, we are bringing back usage of this as the central spot for developers to contribute to.

The source code for the Konveyor operator is located at: https://github.com/konveyor/tackle2-operator

If you want to reference source code, use: https://github.com/konveyor/tackle2-operator
If you want to reference documentation use: https://konveyor.github.io/

As to https://konveyor.github.io/tackle, that is an older link and not intended.

shapirov103 · 2023-06-16T14:21:01Z

lib/addons/olm/index.ts

+      const resources: Construct[] = [];
+      this.manifestUrls!.map((manifestUrl, urlIndex) => {
+        /* eslint-disable */
+        const request = require('sync-request');


This loads the sync-request library in a cycle redefining the function. Can you move it out of the loop?

yes this is bad, addressed.

shapirov103 · 2023-06-16T14:27:15Z

lib/addons/olm/index.ts

+          const manifestDeployment: ManifestDeployment = {
+            name: "olmIdx"+urlIndex+docIndex,
+            namespace: "olm",
+            manifest: [manifest],


why manifest is an array here? should be an actual doc.

addManifest ends up instantiating KubernetesManifest and it looks to me "manifest" is an array type in the param list, as per here: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks.KubernetesManifest.html#construct-props ?

nm, I think we should do a better job on reflecting the types.

shapirov103 · 2023-06-16T14:27:50Z

lib/addons/olm/index.ts

+            values: {}
+          };
+
+          const kubectlProvider = new KubectlProvider(clusterInfo);


there is no need to instantiate kubectlProvider in a loop. let's move out

shapirov103 · 2023-06-16T14:36:52Z

docs/addons/konveyor.md

@@ -0,0 +1,17 @@
+# Konveyor Amazon EKS Blueprints AddOn
+
+This add-on installs [Konveyor](https://konveyor.github.io/).


Please elaborate on the use cases answering the question of why the customer would use this addon, expanding on scenarios where this product is applicable.

Should this point to a different doc portal for tackle2 operator? The documentation page here is misleading and calls out the unmaintained repo as the source which is confusing (to me and I assume the target audience).

https://konveyor.github.io/ is good to use for Konveyor documentation. The repo was stale and needed attention, hence we updated it ~2 weeks ago and are working to revamp this as the central documentation for Konveyor going forward.

shapirov103 · 2023-06-16T14:40:57Z

lib/addons/olm/index.ts

+        resources.push(...batchResources);
+      });
+
+      return Promise.resolve(resources[0]);


should not this be last resource as opposed to 0? If it is first, then it won't wait for the rest of the resources to apply.

jwmatthews · 2023-06-18T09:49:48Z

@freschri I added some tactical feedback, however on a more strategic items I have a few questions:

https://github.com/konveyor/konveyor.github.io does not appear to be production ready. I don't any releases and the versioning schema they are apply is in the alpha range. In addition the repo does not appear to be actively maintained. Most contributions happened last year and I don't observe active development on it. We will only take actively maintained popular OSS projects here, so it appears that this addon may be best served in your personal github repo for now.

Hello, the repo above is not representative of Konveyor. Konveyor is actively being developed and maintained.

That is one of the upstream documentation repos we created to have a single consolidated spot for documentation, we needed to pause that effort and switched to documenting areas in their respective repositories. We are beginning to get back to the consolidated doc effort, but I wouldn't consider it representative to gauge activity on Konveyor.

Konveyor releases as an Operator, as such the first place to look would be the Operator repo which is at:

https://github.com/konveyor/tackle2-operator

The Konveyor operator deploys the components below:

Analysis: https://github.com/windup/windup
Hub: https://github.com/konveyor/tackle2-hub
UI: https://github.com/konveyor/tackle2-ui
Assessments: https://github.com/konveyor/tackle-pathfinder

The majority of development activity in Konveyor is centered on the Hub + UI.

If you have access to the contributors and/or partner sponsoring the OSS then it may be best to move to their repo and we can include some doc updates on it. This PR can be split to just keep the OLM part which is indeed an enabler.
2. OLM being non-helm addon : how do you envision maintenance of this add-on, e.g. version upgrades and testing against latest EKS versions? Do I have your commitment on ownership of this part?

jwmatthews · 2023-06-18T10:29:00Z

docs/addons/konveyor.md

+- [EBS CSI Driver Amazon EKS add-on](https://aws-quickstart.github.io/cdk-eks-blueprints/addons/ebs-csi-driver/) (_EbsCsiDriverAddOn_), to provide Persistent Volumes (PVs) fulfilling Konveyor's Persistent Volume Claims (PVCs)
+- a subdomain for the Konveyor application
+- a certificate for the subdomain, made available by the either _CreateCertificateProvider_ or _ImportCertificateProvider_, to be assigned to the load balancer
+- 


Extra white space for outline to remove?

done thanks

shapirov103

Great progress, a couple of mostly minor notes.

shapirov103 · 2023-06-19T18:29:46Z

docs/addons/konveyor.md

@@ -0,0 +1,17 @@
+# Konveyor Amazon EKS Blueprints AddOn
+
+This add-on installs [Konveyor](https://konveyor.github.io/).


Should this point to a different doc portal for tackle2 operator? The documentation page here is misleading and calls out the unmaintained repo as the source which is confusing (to me and I assume the target audience).

shapirov103 · 2023-06-19T18:39:00Z

lib/addons/konveyor/tackle-manifest.ytpl

@@ -0,0 +1,39 @@
+kind: Tackle
+apiVersion: tackle.konveyor.io/v1alpha1


Hello @jwmatthews, thank you for your feedback, it surely helps. Understand the comment related to the CR API version and upgrades. It is not as intuitive but it surely matches the saying "there is nothing more permanent than temporary" when it comes versioning.

I assume we should change the source references to https://github.com/konveyor/tackle2-operator, please confirm.

Is https://konveyor.github.io/ still the right documentation entry point? I saw a reference to tackle document here pointing to what appears to be the right page: https://konveyor.github.io/tackle. This url, however, is not functioning.

Understand that doc maintenance may not be the top priority, I was a lot more interesting in dev activities, which you confirmed. Thank you.

freschri · 2023-08-16T12:45:03Z

I am closing this PR, following recommendation from Mikhail, requested Claranet availability to host the 2 addons, they confirmed:
repo: https://github.com/claranet-ch/konveyor-eks-blueprint-addon
npm registry: https://www.npmjs.com/package/@claranet-ch/konveyor-eks-blueprint-addon

first commit

a18a677

freschri requested review from aws-ia-ci, a team, parkand1, shapirov103, youngjeong46 and elamaran11 as code owners June 3, 2023 16:13

shapirov103 reviewed Jun 16, 2023

View reviewed changes

jwmatthews reviewed Jun 18, 2023

View reviewed changes

freschri added 2 commits June 18, 2023 11:43

added Konveyor summary and removed local dir reference

c80f4e7

addressing comments from shapirov103

656599f

shapirov103 reviewed Jun 19, 2023

View reviewed changes

updated documentation with more details and links to Konveyor repos

7e836e0

freschri closed this Aug 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Konveyor and OLM add-ons #711

Konveyor and OLM add-ons #711

freschri commented Jun 3, 2023

shapirov103 left a comment •

edited

Loading

shapirov103 Jun 16, 2023

jwmatthews Jun 18, 2023

shapirov103 Jun 19, 2023

jwmatthews Jun 20, 2023

shapirov103 Jun 16, 2023

freschri Jun 18, 2023

shapirov103 Jun 16, 2023

freschri Jun 18, 2023 •

edited

Loading

shapirov103 Jun 19, 2023

shapirov103 Jun 16, 2023

freschri Jun 18, 2023

shapirov103 Jun 16, 2023

freschri Jun 18, 2023

shapirov103 Jun 19, 2023

jwmatthews Jun 20, 2023

shapirov103 Jun 16, 2023

freschri Jun 18, 2023

jwmatthews commented Jun 18, 2023

jwmatthews Jun 18, 2023

freschri Jun 18, 2023

shapirov103 left a comment

shapirov103 Jun 19, 2023

shapirov103 Jun 19, 2023

freschri commented Aug 16, 2023

		@@ -0,0 +1,39 @@
		kind: Tackle
		apiVersion: tackle.konveyor.io/v1alpha1

		@@ -0,0 +1,17 @@
		# Konveyor Amazon EKS Blueprints AddOn

		This add-on installs [Konveyor](https://konveyor.github.io/).

Konveyor and OLM add-ons #711

Konveyor and OLM add-ons #711

Conversation

freschri commented Jun 3, 2023

shapirov103 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freschri Jun 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jwmatthews commented Jun 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shapirov103 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freschri commented Aug 16, 2023

shapirov103 left a comment •

edited

Loading

freschri Jun 18, 2023 •

edited

Loading