Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create new git repository for idpbuilder examples and allow the use of URL for flag -p #184

Closed
csantanapr opened this issue Mar 26, 2024 · 7 comments · Fixed by #255
Closed

Comments

@csantanapr
Copy link
Contributor

csantanapr commented Mar 26, 2024

It would be a good idea to create a git repository with examples that are contributed by the community.

This issue covers two main ideas:

  1. Create a new github repo under the cnoe-io github org to create a library of examples that work out of the box with one command. This includes to move out the existing examples directory from the idpbuilder git repo
  2. Improve the idpbuilder to allow to pass an URL to the -p flag

I'm not sure what would be the name of the git repo some thing like cnoe-examples or idpbuilder-examples or just examples

This allows for the community to open issues requesting end to end examples, and for contributors to provide examples.

The user experience should that user should be able to run idpbuilder with -p and point to an url to deploy the example.

idpbuilder create -p <URL>

The URL format would follow kustomize URL remote targets
It would look like this

idpbuilder create -p https://https://github.com/cnoe-io/examples//ref-implementation
open <backstage-url>

This would git clone the files to a tmp directory, and start idpbuilder create -p using the tmp dir

Using the kustomize go-lib then we can support ssh git, timeouts, ref/branches, etc.

For now user would need to git clone and use idpbuilder.

git clone https://https://github.com/cnoe-io/examples
idpbuilder create -p examples/ref-implementation
@nimakaviani
Copy link
Contributor

this makes sense to me, thanks. I am also wondering whether we should pull out the existing examples directory and submodule it into the core idpbuilder tool for the existing packages to work out of the box.

@blakeromano
Copy link
Contributor

This feels like it should tie in with this proposal -> cnoe-io/proposals#1

@csantanapr
Copy link
Contributor Author

csantanapr commented Mar 26, 2024

@nimakaviani that's what I was proposing, to move out the existing examples directory from this repo to the new examples git repo

pull out the existing examples directory

@nimakaviani
Copy link
Contributor

sure. I am wondering whether submoduling would be a good way to bring it back in or shall we keep them separate

@csantanapr
Copy link
Contributor Author

Friends don't let friends to submodule, unless the friend will automate the upgrade to the submodule reference

@nimakaviani
Copy link
Contributor

haha fair!

@aatchison
Copy link

I agree with the proposal, I was just thinking about this ⬆️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants