diff --git a/CHANGLOG.md b/CHANGLOG.md new file mode 100644 index 0000000..dd34c43 --- /dev/null +++ b/CHANGLOG.md @@ -0,0 +1,22 @@ +# Change Log + + +## [v0.1.0][] (2018-11-26) + +Initial working release + +- Bug Fixes: + + bug when running 2 provisioners (certs + k8s) with the guest mode #10 + +- Tasks: + + should have helm installed by default #2 + + should update to use teracy-dev-core v0.3.0 and teracy-dev-k8s v0.2.0 #4 + + should use teracy-dev-certs #8 + + should update to use teracy-dev v0.6.0-a5 #6 + + should update README and use teracy-dev-certs v0.2.0, teracy-dev-k8s v0.3.0 #15 + + +Details: https://github.com/teracyhq-incubator/teracy-dev-entry-k8s/milestone/1?closed=1 + + +[v0.1.0]: https://github.com/teracyhq-incubator/teracy-dev-entry-k8s/milestone/1?closed=1 diff --git a/README.md b/README.md index bb5ebf7..a7ef9d5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ k8s cluster in the cloud ## Prerequisites -- `vagrant` and `virtualbox` should be installed, follow: https://github.com/teracyhq/dev/blob/develop/docs/getting_started.rst +- Remember to skip this step: http://dev.teracy.org/docs/getting_started.html#teracy-dev-git-clone-and-vagrant-up + +- Install Vagrant (>=2.1.0), VirtualBox (>=5.2) by following this guide http://dev.teracy.org/docs/getting_started.html. ## How to use @@ -18,7 +20,7 @@ $ cd ~/ $ git clone https://github.com/teracyhq/dev.git -b v0.6.0-a5 k8s-dev $ cd k8s-dev $ TERACY_DEV_ENTRY_LOCATION_GIT_REMOTE_ORIGIN=https://github.com/teracyhq-incubator/teracy-dev-entry-k8s.git \ - TERACY_DEV_ENTRY_LOCATION_GIT_BRANCH=develop TERACY_DEV_ENTRY_LOCATION_SYNC=true \ + TERACY_DEV_ENTRY_LOCATION_GIT_BRANCH=master TERACY_DEV_ENTRY_LOCATION_SYNC=true \ vagrant up ``` @@ -111,3 +113,19 @@ teracy-dev-certs: - "accounts.%{node_hostname_prefix}.%{node_domain_affix}" - "login.%{node_hostname_prefix}.%{node_domain_affix}" ``` + +## How to develop + +By default, the "master" branch is always synced. To develop, we must create and configure the `teracy-dev-entry/config_override.yaml` file, for example: + + +``` +teracy-dev: + + entry_location: + git: + remote: + origin: git@github.com:hoatle/teracy-dev-entry-k8s.git # your forked repo + upstream: git@github.com:teracyhq-incubator/teracy-dev-entry-k8s.git + sync: false # you must update the repo manually +``` diff --git a/config_default.yaml b/config_default.yaml index 6444a04..622bf5a 100644 --- a/config_default.yaml +++ b/config_default.yaml @@ -25,7 +25,7 @@ teracy-dev: git: remote: origin: https://github.com/teracyhq-incubator/teracy-dev-entry-k8s.git - branch: develop + branch: master sync: true extensions: diff --git a/docs/release.md b/docs/release.md new file mode 100644 index 0000000..6ab575b --- /dev/null +++ b/docs/release.md @@ -0,0 +1,7 @@ +# Release Steps + +Follow: http://dev.teracy.org/docs/release_process.html + +## Update CHANGLOG.md + +Update the change log