diff --git a/.github/workflows/kaas-docker-image.yml b/.github/workflows/kaas-docker-image.yml index c335dc38..4b8c50ca 100644 --- a/.github/workflows/kaas-docker-image.yml +++ b/.github/workflows/kaas-docker-image.yml @@ -1,13 +1,8 @@ name: Docker image on: - push: - branches: - - '*' - tags: - - 'v[0-9]+.[0-9]+.[0-9]+' - pull_request: - branches: - - '*' + release: + types: [published] + workflow_dispatch: jobs: build: name: Build & push docker image @@ -22,8 +17,8 @@ jobs: - name: Log in to Docker Hub uses: docker/login-action@v2 with: - username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKER_PASSWORD }} + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_PASSWORD }} - name: Build and push Docker image uses: docker/build-push-action@v4 diff --git a/docs/deployment/dockerhub.rst b/docs/deployment/dockerhub.rst new file mode 100644 index 00000000..580dbdee --- /dev/null +++ b/docs/deployment/dockerhub.rst @@ -0,0 +1,19 @@ +| The jupyter hub docker images are at: https://github.com/jupyter/docker-stacks. We will extend them for Kestrel-as-a-Service and other use cases. At the moment the docker image is getting pushed to - https://hub.docker.com/repository/docker/kpeeples/kaas-baseline/general. The dockerfile in this repo includes kestrel-lang, kestrel-analytics, kestrel-huntbook and tutorials. The workflow file automatically builds the image upon commits. +| +| Login to dockerhub using one of the examples: +| A. $ docker login +| Username: +| Password: +| Login Succeeded +| B. $ docker login --username demo --password example +| C. $ cat password.txt | docker login --username demo --password-stdin +| Note: you can use a credential helper - https://docs.docker.com/engine/reference/commandline/login/#credentials-store +| +| Manually Build image using one of the examples, the below url should change to the kestrel-lang url +| A. $ docker build -t kpeeples/kaas-baseline:latest -t kpeeples/kaas-baseline:v1 +| B. $ sudo docker build -t kpeeples/kaas-baseline:latest -t kpeeples/kaas-baseline:v2 https://raw.githubusercontent.com/kpeeples/kestrel-as-a-service/main/dockerhub/Dockerfile +| +| Push image, version should be incremental and will be standardized later +| A. $ sudo docker push kpeeples/kaas-baseline:v1 +| B. $ sudo docker push kpeeples/kaas-baseline:latest +| diff --git a/docs/deployment/index.rst b/docs/deployment/index.rst new file mode 100644 index 00000000..1c93f9bf --- /dev/null +++ b/docs/deployment/index.rst @@ -0,0 +1,13 @@ +================================ +Container Formats for Deployment +================================ + +Docker Format for Dockerhub +=========================== + +.. include:: dockerhub.rst + +OCI Format +========== + +.. include:: oci.rst \ No newline at end of file diff --git a/docs/deployment/oci.rst b/docs/deployment/oci.rst new file mode 100644 index 00000000..f2b2f664 --- /dev/null +++ b/docs/deployment/oci.rst @@ -0,0 +1,2 @@ + +Placeholder for future OCI (Open Container Initiative) - https://opencontainers.org/ diff --git a/docs/index.rst b/docs/index.rst index ce4deb35..57fe4142 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,7 @@ talks, community entrances, and more. configuration debug runtime + deployment/index theory talks contributing diff --git a/src/containers/docker/README.rst b/src/containers/docker/README.rst deleted file mode 100644 index eae73861..00000000 --- a/src/containers/docker/README.rst +++ /dev/null @@ -1,21 +0,0 @@ -The jupyter hub docker images are at: https://github.com/jupyter/docker-stacks. We will extend them for Kestrel-as-a-Service and other use cases. At the moment the docker image is getting pushed to - https://hub.docker.com/repository/docker/kpeeples/kaas-baseline/general. The dockerfile in this repo includes kestrel-lang, kestrel-analytics, kestrel-huntbook and tutorials. The workflow file automatically builds the image upon commits. - -Steps to manually create the image: - -- Login to dockerhub using one of the examples -A. $ docker login -Username: -Password: -Login Succeeded -B. $ docker login --username demo --password example -C. $ cat password.txt | docker login --username demo --password-stdin -Note: you can use a credential helper - https://docs.docker.com/engine/reference/commandline/login/#credentials-store - -- Manually Build image using one of the examples, the below url should change to the kestrel-lang url -A. $ docker build -t kpeeples/kaas-baseline:latest -t kpeeples/kaas-baseline:v1 -B. $ sudo docker build -t kpeeples/kaas-baseline:latest -t kpeeples/kaas-baseline:v2 https://raw.githubusercontent.com/kpeeples/kestrel-as-a-service/main/dockerhub/Dockerfile - -- Push image, version should be incremental and will be standardized later -A. $ sudo docker push kpeeples/kaas-baseline:v1 -B. $ sudo docker push kpeeples/kaas-baseline:latest -