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

rcnnnghm/k8s release docs #406

Closed
wants to merge 24 commits into from

Conversation

rcnnnghm
Copy link
Collaborator

@rcnnnghm rcnnnghm commented Oct 4, 2024

List of items changed:

  • Removed references to managed.hopsworks.ai
  • Changed "Setup and Installation" to "Setup and Administration"
  • Moved "Common" to "Managed" and left as tab in UI for review
  • Moved items from "Administration" tab into "Setup and Administration"
  • Removed references to karamel

NB Need to remove "Managed" tab before merge.

@SirOibaf
Copy link
Contributor

SirOibaf commented Oct 6, 2024

Couple of comments:

  • Need to remove the Hopsworks installer section
  • Step 6 on the different pages point to some google collab notebooks which I'm not sure it's up to date, as well as the hops-examples repo which has been archived in favour of the hopsworks-tutorial repo

@SirOibaf
Copy link
Contributor

SirOibaf commented Oct 6, 2024

  • the URL for the helm repository only has the development helm charts, not the released one. My understanding was that users are supposed to first agree to the eval/startup license (here: https://www.hopsworks.ai/try) which will then reveal the helm repo URL. Right now it's the documentation - I think the documentation should link to the link above.
  • The alias for the helm repo when cloned should be hopsworks not hopsworks-dev.
  • You don't need to create the secret anymore, nor provide username and password to register the helm chart repo - So we should remove those from the documetation
  • We should remove the --devel flag from the helm install documentation since that's only needed from not -released verisons.

@SirOibaf
Copy link
Contributor

SirOibaf commented Oct 6, 2024

  • The documentation for AWS contains a values file which I wrote and excludes some stuff I don't needed (e.g. the Kserve) - Also some of the attributes have changes and the values.yaml file is no longer valid. We should remove it from the documentation.

@rcnnnghm
Copy link
Collaborator Author

rcnnnghm commented Oct 7, 2024

Couple of comments:

  • Need to remove the Hopsworks installer section
  • Step 6 on the different pages point to some google collab notebooks which I'm not sure it's up to date, as well as the hops-examples repo which has been archived in favour of the hopsworks-tutorial repo

I re-worked the content of the installer section to be a shortened on-premise backgrounder with call
to action of contacting Hopsworks.

I also removed references to the hops-examples repo, the google collab notebooks require a larger overhaul of the tutorials to use "!pip install requirements.txt" given the new multi-environment world.

I will come back to this once I agree a structure with the relevant people.

@rcnnnghm
Copy link
Collaborator Author

rcnnnghm commented Oct 7, 2024

  • the URL for the helm repository only has the development helm charts, not the released one. My understanding was that users are supposed to first agree to the eval/startup license (here: https://www.hopsworks.ai/try) which will then reveal the helm repo URL. Right now it's the documentation - I think the documentation should link to the link above.
  • The alias for the helm repo when cloned should be hopsworks not hopsworks-dev.
  • You don't need to create the secret anymore, nor provide username and password to register the helm chart repo - So we should remove those from the documetation
  • We should remove the --devel flag from the helm install documentation since that's only needed from not -released verisons.

These should all be addressed now.

@rcnnnghm
Copy link
Collaborator Author

rcnnnghm commented Oct 7, 2024

  • The documentation for AWS contains a values file which I wrote and excludes some stuff I don't needed (e.g. the Kserve) - Also some of the attributes have changes and the values.yaml file is no longer valid. We should remove it from the documentation.

I removed the reference to kube kserve in the values.yaml file but I wasn't sure if there were other updates I should do to the values.yaml file. If you have one in mind, I'd be happy to include it.

@rcnnnghm rcnnnghm requested a review from SirOibaf October 24, 2024 07:48
@rcnnnghm rcnnnghm closed this Oct 24, 2024
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 this pull request may close these issues.

2 participants