Skip to content

Samples are not easy to consume due to usage of parent in pom #257

@wtrocki

Description

@wtrocki

The idea of the samples should be that I should be able to grab folders outside repo and they should work.
From a maintenance standpoint and verification that might be bad as repo possibly needs to depend on the compiled examples etc. but from the usage point of view there is some extra work need to get this working outside the repository.

This would be something that simple CLI/Maven Artifacts could fix.
Happy to build CLI for java operator if needed and add some capability to generate operator.

Activity

changed the title [-]Samples are not easy to consume due to extensive usage of parents. [/-] [+]Samples are not easy to consume due to usage of parent in pom[/+] on Dec 16, 2020
s-soroosh

s-soroosh commented on Dec 16, 2020

@s-soroosh
Contributor

Thank you @wtrocki for bringing this topic up, indeed using the samples should be simpler than what it is.
I agree with building an initiator to setup the project.
It could be used to address #28 and the current issue.
I would suggest we make a new repo for it rather than a new module here to ensure it's developed in an isolated environment and its releases not being dependent on the SDK releases.

What do you think @adam-sandor @csviri @metacosm?

metacosm

metacosm commented on Dec 16, 2020

@metacosm
Collaborator

I'd argue that the samples should maybe be in a different repository. A generator to generate a skeleton operator would also help.

adam-sandor

adam-sandor commented on Dec 16, 2020

@adam-sandor
Collaborator

Separate repos for each sample or single samples repo? I'd vote for single samples repo, so when the framework changes we can upgrade the samples with one PR.

csviri

csviri commented on Dec 17, 2020

@csviri
Collaborator

The original idea was, when we started to extract the samples, that we have just a few simple samples, that supports only the development maybe some quick checking / testing, that sample works with the update.
And other samples (which are more complex) should be extracted to a separate repo, I would say it's own. And there should be not too much of them.

adam-sandor

adam-sandor commented on Dec 17, 2020

@adam-sandor
Collaborator

I think single repo for all (non-test) samples would be better. Easier to browse all the samples and easier to upgrade them on FW change.

csviri

csviri commented on Dec 17, 2020

@csviri
Collaborator

That is true that is easier to upgrade them. So maybe the examples which are kind of showcases we should have in one repo.
Question is what about the memcached, if the intention is to have it as a production ready operator, that should be a separate repo. Not sure if that is the intention.

adam-sandor

adam-sandor commented on Dec 17, 2020

@adam-sandor
Collaborator

I don't think memcached will be a production ready operator and it should actually go into the repo in the operator-sdk with the other memcached samples.

csviri

csviri commented on Dec 17, 2020

@csviri
Collaborator

@adam-sandor you mean a separate repo with the samples, or directly to the SDK?

csviri

csviri commented on Dec 17, 2020

@csviri
Collaborator

Ok, now I'm completely lost how you mean this, let's discuss it maybe on next weekly.

wtrocki

wtrocki commented on Dec 17, 2020

@wtrocki
Author

Is weekly open for community. Would love to join as listener?

s-soroosh

s-soroosh commented on Dec 17, 2020

@s-soroosh
Contributor

+1 for a repo with samples and deprecate the tomcat-operator.

adam-sandor

adam-sandor commented on Dec 17, 2020

@adam-sandor
Collaborator

@wtrocki please jump in our Discord channel (https://discord.gg/DacEhAy) you can find the invite as a pinned message in the general channel. You are very welcome to join the weeklys.

adam-sandor

adam-sandor commented on Dec 17, 2020

@adam-sandor
Collaborator

This is my proposal:

.h4 java-operator-sdk/operator-framework/samples

  • basic sample with all features used in some contrived way

.h4 java-operator-sdk/samples

  • spring-boot
  • quarkus
  • mysql-schema (demonstrating managing external resources)
  • tomat (demonstrating multiple controllers and Kubernetes resource management)
  • webserver (competition to Tomcat, we should choose if we use this or the Tomcat sample)

.h4 operator-framework/operator-sdk-samples

  • java-memcached
metacosm

metacosm commented on Jan 22, 2021

@metacosm
Collaborator

@charlottemach you mentioned you were interested in taking this on during the last weekly call, is it still the case?

added
examplesImprovements to the example projects
help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.
on Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    examplesImprovements to the example projectsgood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jmrodri@metacosm@s-soroosh@wtrocki@csviri

        Issue actions

          Samples are not easy to consume due to usage of parent in pom · Issue #257 · operator-framework/java-operator-sdk