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.

Sign up for GitHub

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

Remove outdated sdkbase directory and docs #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76e3728
try removing sdkbase dir
ialarmedalien Jun 16, 2020
c03ad16
Merge branch 'develop' into remove_sdkbase_dir
ialarmedalien Sep 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
/temp
/dist
/eclipse-classes/
/sdkbase/ssl
/sdkbase/cluster.ini
/classes/
/temp_*
/ASimpleModule*
Expand Down
1 change: 0 additions & 1 deletion .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ install:

script:
- make
- make sdkbase
- export PATH=$(pwd)/bin:$PATH
- source src/sh/sdk-completion.sh
- kb-sdk help
Expand Down
7 changes: 1 addition & 6 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ KBASE_COMMON_JAR = kbase/common/kbase-common-0.0.23.jar
QUOTE = '\''

# make sure our make test works
.PHONY : test test-python sdkbase
.PHONY : test test-python


default: compile
Expand Down Expand Up @@ -103,11 +103,6 @@ deploy-scripts:
fi;
$(ANT) deploy_bin -DBIN_TARGET=$(TARGET)/bin -DBIN_LIB_TARGET=$(TARGET)/lib -DKBASE_COMMON_JAR=$(KBASE_COMMON_JAR)

sdkbase:
# docker rmi -f kbase/deplbase:latest
cd sdkbase && ./makeconfig
docker build --no-cache -t kbase/kbase:sdkbase2.latest sdkbase

test: submodule-init
@echo "Running unit tests"
make test-python
Expand Down
13 changes: 4 additions & 9 deletions doc/building_sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,30 @@
#### Building SDK
## Building the SDK

System Dependencies:

- Mac OS X 10.8+ or Linux. kb-sdk does not run natively in Windows, but see [here](doc/FAQ.md#windows) for more details.
- Java JRE 7 or 8 (9 is currently incompatible) http://www.oracle.com/technetwork/java/javase/downloads/index.html
- Java JRE 8: http://www.oracle.com/technetwork/java/javase/downloads/index.html (9 is currently incompatible; the SDK will run on Java 7, but using the more modern Java 8 is recommended)
- (Mac only) Xcode https://developer.apple.com/xcode
- git https://git-scm.com
- Docker https://www.docker.com (for local testing)

Get the SDK:

git clone https://github.com/kbase/kb_sdk
git clone https://github.com/kbase/jars

Pull dependencies and configure the SDK:

cd kb_sdk
make bin

Download the local KBase SDK base Docker image:

docker pull kbase/sdkbase2:latest

Comment on lines -20 to -23
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.

Add the kb-sdk tool to your PATH and enable command completion. From the kb_sdk directory:

# for bash
export PATH=$(pwd)/bin:$PATH
source src/sh/sdk-completion.sh


#### Build from source
### Build from source

Additional System Dependencies:

Expand All @@ -39,4 +35,3 @@ Follow basic instructions above. Instead of running `make bin` you can run `mak

cd kb_sdk
make

1 change: 0 additions & 1 deletion doc/codebase_anatomy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ This document describes the the file structure of the `kb_sdk` codebase.
* `Makefile` - commands for compiling, building docker images, and initializing submodules
* `Pipfile` and `Pipfile.lock` - python dependencies for pipenv
* `reports/` - files generated for JaCoCo test coverage reports
* `sdkbase/` - Docker files for the image used inside actual SDK apps
* `src/` - the main source code for this project; see below
* `submodules/` and `submodules_hacks` - jars and other dependencies
* `test_scripts/` - test helpers in perl, python, and js
Expand Down
3 changes: 0 additions & 3 deletions entrypoint
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ fi

exec docker run -it --rm -v \$HOME:\$HOME -u \$(id -u) -w \$(pwd) -v /var/run/docker.sock:/var/run/docker.sock -e DUSER=\$USER -e DSHELL=\$SHELL -e KBASE_TEST_TOKEN=\$KBASE_TEST_TOKEN --group-add \$(cat \$HOME/.kbsdk.cache) kbase/kb-sdk \$@
EOF
elif [ "z$1" = "zsdkbase" ] || [ "z$1" = "zpull-base-image" ] ; then
echo "Pulling and tagging the base image"
docker pull kbase/kbase:sdkbase2.latest
elif [ "z$1" = "zprune" ] ; then
echo "Used during build to shrink image. Not needed by the user."
for f in $(find /src/submodules/jars/lib/jars -type f -name '*.jar') ; do
Expand Down
44 changes: 0 additions & 44 deletions sdkbase/Dockerfile
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions sdkbase/create_certs
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion sdkbase/lets_encript/lets-encript-readme.txt
View file
Open in desktop

This file was deleted.

Binary file removed sdkbase/lets_encript/lets-encrypt-x3-cross-signed.der
View file
Open in desktop
Binary file not shown.
4 changes: 0 additions & 4 deletions sdkbase/makeconfig
View file
Open in desktop

This file was deleted.

Loading