Skip to content

Commit

Permalink
Update from PR comments and recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
kpeeples committed Aug 31, 2023
1 parent a7ddc89 commit 281f174
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 31 deletions.
15 changes: 5 additions & 10 deletions .github/workflows/kaas-docker-image.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
19 changes: 19 additions & 0 deletions docs/deployment/dockerhub.rst
Original file line number Diff line number Diff line change
@@ -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
|
13 changes: 13 additions & 0 deletions docs/deployment/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
================================
Container Formats for Deployment
================================

Docker Format for Dockerhub
===========================

.. include:: dockerhub.rst

OCI Format
==========

.. include:: oci.rst
2 changes: 2 additions & 0 deletions docs/deployment/oci.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

Placeholder for future OCI (Open Container Initiative) - https://opencontainers.org/
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ talks, community entrances, and more.
configuration
debug
runtime
deployment/index
theory
talks
contributing
Expand Down
21 changes: 0 additions & 21 deletions src/containers/docker/README.rst

This file was deleted.

0 comments on commit 281f174

Please sign in to comment.