Skip to content

Commit

Permalink
Merge pull request #1394 from LinuxSuRen/dev-guide
Browse files Browse the repository at this point in the history
Add a section to introduce how to test the ks-installer
  • Loading branch information
ks-ci-bot authored Apr 9, 2021
2 parents 51d7835 + 108fd37 commit 183c2fe
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,17 @@
Welcome to kubesphere/ks-installer! To learn more about contributing to the [ks-installer code repo](README.md), check out the [Developer Guide](https://github.com/kubesphere/community/tree/master/developer-guide/development).

The [KubeSphere community repo](https://github.com/kubesphere/community) contains information about how to get started, how the community organizes, and more.

# Manual Test

If you want to test against a component with `ks-installer`. Please follow these steps:

* Create a new git feature branch
* Change the Docker image tags of your desired component in file [main.yml](roles/download/defaults/main.yml)
* Build the Docker image of `ks-installer`
* Please provide a accessible image path, e.g. `make all -e REPO=surenpi/ks-installer`
* Create a Kubernetes cluster without KubeSphere
* Install a [k3s](https://github.com/k3s-io/k3s/) might be easy solution for the test purpose
* Install the ks-installer
* Switch the image to your desired one in file `deploy/kubesphere-installer.yaml`
* Install it via: `kubectl apply -f deploy/`
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
REPO?=kubespheredev/ks-installer
TAG:=$(shell git rev-parse --abbrev-ref HEAD)-dev

build:
docker build . --file Dockerfile --tag $(REPO):$(TAG)
push:
docker push $(REPO):$(TAG)
all: build push

0 comments on commit 183c2fe

Please sign in to comment.