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

Remove outdated sdkbase directory and docs #353

Merged
merged 2 commits into from
Sep 14, 2020
Merged

Conversation

ialarmedalien
Copy link
Collaborator

The sdkbase directory is no longer used as new KBase apps are built on sdkbase2. This PR removes the old sdkbase directory and mentions of it in the documentation.

Closes #351.

Comment on lines -20 to -23
Download the local KBase SDK base Docker image:

docker pull kbase/sdkbase2:latest

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the correct image for python apps, which would presumably be what the majority of people will be building. The correct image will be pulled automatically when building a new app, so it's easier to omit this step completely.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So have we tried to rebuild some images with this setup? I'm somewhat leery when we remove a while directory.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The automated tests for this repo all use this setup (i.e. ignoring the sdkbase directory), as does anyone who runs docker pull kbase/kb-sdk.

The only way that people might use the code is if they ran make sdkbase, which builds an app base image with the ID kbase/kbase:sdkbase2.latest. There were some vague/incomplete instructions in the docs about building kb-sdk from source about running make sdkbase, but I found that whenever I ran the command and then used kb-sdk to generate apps, the apps were on a weird base image, and some additional tests that I'd put in failed. I believe this was the precursor to the modern sdkbase images, which are now held in https://github.com/kbase/sdkbase2.

@MrCreosote
Copy link
Member

MrCreosote commented Sep 11, 2020

Where does the SDK base image Dockerfile live these days?

Edit:
I guess I have two questions:

  1. Where does the Dockerfile for the app base image(s) live
  2. Where does the Dockerfile for the dockerized version of kb-sdk live

@ialarmedalien
Copy link
Collaborator Author

@MrCreosote:

  1. The app base images are in https://github.com/kbase/sdkbase2; there are two branches, python, for py3 apps, and master, for perl and java apps (and py2). When you use the SDK to create an app, the dockerfile will be based on one of those two images.
  2. Are you referring to the Dockerfile for kb-sdk itself - i.e. what makes the image that you get if you run docker pull kbase/kb-sdk? If so, it is in this repo: https://github.com/kbase/kb_sdk/blob/develop/Dockerfile

@MrCreosote
Copy link
Member

Are you referring to the Dockerfile for kb-sdk itself - i.e. what makes the image that you get if you run docker pull kbase/kb-sdk? If so, it is in this repo: https://github.com/kbase/kb_sdk/blob/develop/Dockerfile

Wait - so dockerized kb-sdk isn't released?

So am I right in thinking that the sdkbase directory is completely unused everywhere, based on the answers above?

@ialarmedalien
Copy link
Collaborator Author

ialarmedalien commented Sep 14, 2020

@MrCreosote Yup! The sdkbase directory is unused.

@MrCreosote
Copy link
Member

And dockerized kb-sdk isn't released?

@ialarmedalien
Copy link
Collaborator Author

Dockerized kb-sdk is available via docker pull kbase/kb-sdk.

@MrCreosote
Copy link
Member

But the dockerfile is on the develop branch, hence not released, right?

@ialarmedalien
Copy link
Collaborator Author

This is the current status of kb-sdk docker images:

https://hub.docker.com/r/kbase/kb-sdk/tags

master (aka latest) has not been updated in 2+ years. The kb-sdk image tagged develop will soon be automatically uploaded every time there's a merge into develop.

@sychan sychan merged commit 7df70d8 into develop Sep 14, 2020
@sychan sychan deleted the remove_sdkbase_dir branch September 14, 2020 18:05
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.

Outdated 'sdkbase' directory
3 participants