Verified Commit 244e74e9 authored by Varac's avatar Varac
Browse files

Release 0.2.0

Closes: #342
parent d081d984
......@@ -4,6 +4,29 @@
No unreleased changes yet.
## [0.2.0] - 2091-10-22
* Release candidate for second user test
* Added features:
* Use onlyoffice image with support for unlimited connections
* Make local-storage work with subpath mounted PVs
* Logrotate OAS logs
* Rewrite and improve OAS installation script
* Include and update documentation in this repo
* Allow custom rke config options
* Update to rke 0.2.7
* Update k8s to v1.14.3-rancher1-1
* Update cert-manager to v0.9.1
* Pin helm to 2.14.3
* Fix nextcloud issues from user feedback
* Fix and improve CI tests and pipeline
Known issues:
* There are some [initial prometheus alerts](https://open.greenhost.net/openappstack/openappstack/issues/286)
after a fresh OAS installation
* [Prometheus web interface is publicly available](https://open.greenhost.net/openappstack/openappstack/issues/294)
## [0.1.0] - 2019-07-31
This is the version for the alpha test.
......@@ -41,15 +41,16 @@ guide][https://openappstack.net/contact.html).
## Install OpenAppStack command line tool
On your **provisioning machine**, clone the OpenAppStack git repository:
On your **provisioning machine**, clone the OpenAppStack git repository and
checkout the latest stable version (currently `0.2.0`):
$ git clone https://open.greenhost.net/openappstack/openappstack.git
$ git clone -b 0.2.0 https://open.greenhost.net/openappstack/openappstack.git
$ cd openappstack
If you installed `virtualenv`, create a python virtual environment called "env"
that uses python 3. This makes sure we do not change any of your other python
projects. The second command "activates" the virtualenv.
projects. The second command "activates" the virtualenv.
> **NOTE:** Activating the virtualenv means you will use that environment to
> install and run python programs instead of your global environment. If you
......@@ -59,7 +60,7 @@ projects. The second command "activates" the virtualenv.
$ python3 -m venv env
$ . env/bin/activate
Next, install the OpenAppStack CLI client by running the following commands:
Next, install the OpenAppStack CLI client by running the following commands:
$ pip3 install -r requirements.txt
......@@ -67,7 +68,7 @@ Next, install the OpenAppStack CLI client by running the following commands:
> fault](https://bitbucket.org/cffi/cffi/issues/272/segfault-while-installing-via-pip),
> you can add `--no-use-wheel` to it.
Now you can run the OpenAppStack CLI as follows:
Now you can run the OpenAppStack CLI as follows:
$ python -m openappstack CLUSTER_NAME <command>
......@@ -79,7 +80,7 @@ repository. Try it out by running
## Install OpenAppStack
Setting up OpenAppStack on your VPS happens in three steps:
Setting up OpenAppStack on your VPS happens in three steps:
1. **Set up cluster**
......@@ -100,19 +101,19 @@ Setting up OpenAppStack on your VPS happens in three steps:
To set up your cluster, use the `create` subcommand of the OpenAppStack CLI.
First, choose a name for your cluster. Then run the following command to get
information about the `create` subcommand:
information about the `create` subcommand:
$ python -m openappstack CLUSTER_NAME create --help
Replace `CLUSTER_NAME` with your chosen name.
There are two options to create a cluster:
There are two options to create a cluster:
#### Use a Greenhost VPS
- For this to work, you need to have an API key with Customer rights.
1. In the Cosmos service centre, click your name on the top right corner
2. Go to "User settings"
2. Go to "User settings"
3. Click "API keys"
4. Click "New API key"
5. Click "Generate new key"
......@@ -150,13 +151,13 @@ There are two options to create a cluster:
- In both cases you need to provide the `DOMAIN_NAME` positional argument.
If you use a subdomain (e.g. oas.yourdomain.com), use the `--subdomain`
command as follows:
command as follows:
```
$ python -m openappstack create --subdomain oas example.org`.
```
- Here is an example of the complete creation command:
- Here is an example of the complete creation command:
```
python -m openappstack my-cluster create --create-droplet --hostname oas.example.org --ssh-key-id 112 --create-domain-records --subdomain oas example.org
......@@ -176,13 +177,13 @@ There are two options to create a cluster:
If you want to follow this step, we assume you already have a VPS. You'll need
its *hostname* and its *IP address*. Also check that your VPS meets our
[prerequisites](#prerequisites).
[prerequisites](#prerequisites).
> **WARNING:** the OpenAppStack installation makes substantial changes to your
> whole VPS and needs root access. It is not advised to follow these
> instructions on a VPS that you are using for something else too.
Create the OpenAppStack settings for your VPS by running the following command:
Create the OpenAppStack settings for your VPS by running the following command:
```
$ python -m openappstack create --ip-address IP_ADDRESS --hostname HOSTNAME --subdomain oas example.org
......@@ -193,7 +194,7 @@ $ python -m openappstack create --ip-address IP_ADDRESS --hostname HOSTNAME --su
Before you continue, if you have not made DNS entries with the CLI tool, you
need to make them now. It is important to start with configuring DNS because
depending on your DNS setup/provider, it takes a while (sometimes hours) to
propagate.
propagate.
You need one dedicated (sub)domain entry and a wildcard entry for everything
inside it. For example, create an A record for these domains:
......@@ -256,7 +257,7 @@ You can access Nextcloud via https://files.example.org. Use the username
`clusters/maarten/secrets/nextcloud_admin_password` on your local machine.
ONLYOFFICE is already integrated in your Nextcloud installation which allows you
to create and share ONLYOFFICE documents within Nextcloud. ONLYOFFICE runs on
https://office.oas.example.org.
https://office.oas.example.org.
### Known limitations of Nextcloud & ONLYOFFICE
......@@ -288,18 +289,18 @@ Besides these applications, some other auxiliary components are installed:
You can use `kubectl`, the Kubernetes control program, to find and manipulate
your Kubernetes cluster. Once you have installed `kubectl`, to get access to your
cluster with the OAS CLI:
cluster with the OAS CLI:
$ python -m openappstack my-cluster info
Look for these lines:
Look for these lines:
To use kubectl with this cluster, copy-paste this in your terminal:
export KUBECONFIG=/home/you/projects/openappstack/clusters/my-cluster/secrets/kube_config_cluster.yml
Copy the whole `export` line into your terminal. In *that* terminal, kubectl
will connect to your cluster.
will connect to your cluster.
> **NOTE:** you have to repeat this step in new terminals and terminal tabs.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment