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

Feature: Automate getting started guide #1228

Open
4 tasks
bernardhalas opened this issue Feb 16, 2024 · 2 comments
Open
4 tasks

Feature: Automate getting started guide #1228

bernardhalas opened this issue Feb 16, 2024 · 2 comments
Labels
feature New feature

Comments

@bernardhalas
Copy link
Member

bernardhalas commented Feb 16, 2024

Motivation

When preparing for a new Claudie demo on new project, creating the accounts is susceptible to copy/paste mistakes and takes a substantial amount of time. Even when not using DNS and LBs, I need to account for ~2 hrs of time per one cloud provider and the result is not guaranteed. The approach of copy/pasting 10-11 commands per cloud provider has the following risks:

  • copy/paste errors (e.g. in case of a different shell environment - fish or zsh)
  • mix 'n match of various naming conventions (e.g. userocid and user_ocid) - difficult to check the syntax of the commands
  • rewiring the client CLIs like oci aws or gcloud especially if a user already has them bound to different accounts/projects
  • various python versions + installations which might prevent a successful CLI installation
  • copy/paste errors in the input manifest

Description

I'd expect to have an interactive command-line CLI/script, that would:

  • ask only the absolutely essential information
  • fire up provider CLI (from an image) and do the login
  • perform all the actions and generate secrets locally
  • apply the claudie manifest + secrets + basic input manifest which the user can tune later

Exit criteria

  • High-level design is reviewed and OK'd by the team
  • The script or CLI is implemented
  • Docs are updated
  • Create an image with provider CLIs + the script or Claudie CLI
@bernardhalas bernardhalas added the feature New feature label Feb 16, 2024
@Despire
Copy link
Contributor

Despire commented Feb 16, 2024

fire up provider CLI (from an image) and do the login

This does not make much sense, would we spin up multiple images each for a unique provider ?

Why not just make it work directly with the cloud CLIs (if possible) without images. With this the CLI/scripts could be run directly on the HOST or in a single docker container (possibly if the CLI/scripts would also install the necessary dependent cloud CLI's if not present on the HOST)

@bernardhalas
Copy link
Member Author

I agree with the statement @Despire . I suggest to pack the resulting CLI in a docker image with provider CLIs.

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

No branches or pull requests

2 participants