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

Hubploy-Template Update Spree #9

Open
salvis2 opened this issue Aug 18, 2020 · 0 comments
Open

Hubploy-Template Update Spree #9

salvis2 opened this issue Aug 18, 2020 · 0 comments

Comments

@salvis2
Copy link
Collaborator

salvis2 commented Aug 18, 2020

This repo is a part of hubploy in that it is the required directory structure and enables new users to get started much faster by templating their own repos with this one. That said, this repo is very far behind hubploy development and documentation. Here are some thing I'd like to update:

  1. Readme: The readme is the old deployment instructions. These instructions now live in the docs, so we can update the Readme to have a more high-level description with links to hubploy, the docs, etc.
  2. Hubploy image: this uses an old version of hubploy as-is and that version should be updated.
  3. Local install instructions: The first deployment is recommended by command-line, which is fine. However, this has you do a pip install, which I haven't had success with in a while because it links to an old version. It looks like we can just change the commit hash in requirements.txt to be more up-to-date and update it on stable "releases." I've done a lot of local hubploy installing / linking with pip install -e ~/<absolute-path-to>/hubploy but I'm unsure if we should recommend that. It's mentioned in the docs for setting up a dev environment; maybe that's good enough.
  4. Add note about needing the cloud credentials file's profile to be default. See Kubeconfig update call requires default aws credentials berkeley-dsep-infra/hubploy#45

Will think more on this. Feel free to suggest more changes on how we can make this repo helpful and easy to use!

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

No branches or pull requests

1 participant