From b1a115782be569b7c9beb1d27b74e5e61cb20eb3 Mon Sep 17 00:00:00 2001
From: Maarten de Waard <maarten@greenhost.nl>
Date: Fri, 5 Nov 2021 08:55:06 +0100
Subject: [PATCH] rename all occurences of OpenAppStack to Stackspipin
---
.gitlab/issue_templates/feedback.md | 4 +--
.pre-commit-config.yaml | 2 +-
CONTRIBUTING.md | 2 +-
Dockerfile | 2 +-
LICENSE | 2 +-
README.md | 4 +--
ansible/group_vars/all/oas.yml | 2 +-
.../roles/compatibility-checks/tasks/main.yml | 2 +-
ansible/roles/configure/files/README.md | 6 ++--
.../roles/configure/files/oas-version-info.sh | 2 +-
ansible/roles/configure/tasks/main.yml | 4 +--
docs/comparable_projects.md | 16 +++++-----
docs/conf.py | 2 +-
docs/customizing.rst | 4 +--
docs/design.md | 26 ++++++++--------
docs/index.rst | 14 ++++-----
docs/installation/create_cluster.rst | 18 +++++------
docs/installation/install_oas.rst | 30 +++++++++----------
docs/installation/overview.rst | 20 ++++++-------
docs/maintenance.rst | 8 ++---
docs/reference.md | 4 +--
docs/requirements.in | 2 +-
docs/testing.rst | 8 ++---
docs/troubleshooting.rst | 10 +++----
...ube-prometheus-stack-values-configmap.yaml | 2 +-
.../nextcloud/nextcloud-values-configmap.yaml | 2 +-
.../rocketchat-values-configmap.yaml | 2 +-
.../wordpress/wordpress-values-configmap.yaml | 2 +-
.../single-sign-on-values-configmap.yaml | 2 +-
...cal-path-provisioner-values-configmap.yaml | 2 +-
install/flux-version-check.sh | 2 +-
openappstack/__main__.py | 6 ++--
openappstack/ansible.py | 2 +-
openappstack/cluster.py | 2 +-
requirements.in | 2 +-
test/taiko/single-sign-on.js | 6 ++--
36 files changed, 112 insertions(+), 114 deletions(-)
diff --git a/.gitlab/issue_templates/feedback.md b/.gitlab/issue_templates/feedback.md
index ff674008a..4e15a5fca 100644
--- a/.gitlab/issue_templates/feedback.md
+++ b/.gitlab/issue_templates/feedback.md
@@ -4,7 +4,7 @@ This feedback template can be used to provide feedback based on the [OAS testing
> What problems did you encounter during installation? (If these problems prevent you from continuing with the testing process please provide some details what went wrong so we may try to help you get unstuck!)
-> We know that the installation process as it is right now is too technical, especially given that we want OpenAppStack to be easy to use for people that are only moderately computer-savvy.
+> We know that the installation process as it is right now is too technical, especially given that we want Stackspin to be easy to use for people that are only moderately computer-savvy.
> We plan to make the installation process easier in the future, probably using some kind of web-based installer.
> Even so, what do you think could be improved about the installation process or tutorial ? Did anything bother you, was something extra hard to do, or unclear?
@@ -34,6 +34,6 @@ This feedback template can be used to provide feedback based on the [OAS testing
# Closing questions
-> What's missing? Now that you have gotten an idea of OpenAppStack's initial offering (Nextcloud and OnlyOffice), think of what the next thing is your organisation would need to collaborate more efficiently. Or think of a tool that you or your organisation use a lot that is also "centralised" (e.g., something exclusively provided by Google, Microsoft or a different company)
+> What's missing? Now that you have gotten an idea of Stackspin's initial offering (Nextcloud and OnlyOffice), think of what the next thing is your organisation would need to collaborate more efficiently. Or think of a tool that you or your organisation use a lot that is also "centralised" (e.g., something exclusively provided by Google, Microsoft or a different company)
> Do you have any other questions, comments, remarks, suggestions?
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 80d49132d..21366c080 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -22,7 +22,7 @@ repos:
- repo: https://github.com/hadolint/hadolint
rev: v1.23.0
hooks:
- - id: hadolint
+ - id: hadolint-docker
- repo: https://github.com/timothycrosley/isort
# Sorts import statements for you
rev: 5.0.9
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3002d6ab5..c7f10f523 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -102,7 +102,7 @@ use it. This is a manual process for now. Follow these steps:
# Remove k3s state
rm -rf /var/lib/rancher/k3s
```
-5. Log into Cosmos with the OpenAppStack account
+5. Log into Cosmos with the Stackspin account
6. Go to VPS Cloud -> VPS and shut down your VPS
7. Go to VPS Cloud -> Disk Images and click `Manage` for your VPSs disk image
1. Change the Disk Label to something like `k3s-template-DATE`
diff --git a/Dockerfile b/Dockerfile
index a335ff0da..94559f79d 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,7 +1,7 @@
# https://hub.docker.com/_/alpine?tab=tags
FROM alpine:3.14
-LABEL name="OpenAppStack management"
+LABEL name="Stackspin management"
LABEL version="4.4"
LABEL vendor1="Greenhost"
diff --git a/LICENSE b/LICENSE
index 2295af0e5..dbba251fe 100644
--- a/LICENSE
+++ b/LICENSE
@@ -630,7 +630,7 @@ state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
bootstrap
- Copyright (C) 2019 OpenAppStack
+ Copyright (C) 2019 Stackspin
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
diff --git a/README.md b/README.md
index db86e5fde..ba4c76171 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# OpenAppStack
+# Stackspin
-OpenAppStack allows you to easily set up a new OpenAppStack instance, based on
+Stackspin allows you to easily set up a new Stackspin instance, based on
a single-node kubernetes cluster.
> **WARNING: The installation process will make substantial changes to the
diff --git a/ansible/group_vars/all/oas.yml b/ansible/group_vars/all/oas.yml
index c097ab766..8ee195e8e 100644
--- a/ansible/group_vars/all/oas.yml
+++ b/ansible/group_vars/all/oas.yml
@@ -1,6 +1,6 @@
---
# Directory to store generated configuration and cluster state.
-data_directory: "/var/lib/OpenAppStack"
+data_directory: "/var/lib/Stackspin"
ip_address: "{{ hostvars[inventory_hostname]['ansible_default_ipv4']['address'] }}"
# Use python3 on cluster nodes for ansible
diff --git a/ansible/roles/compatibility-checks/tasks/main.yml b/ansible/roles/compatibility-checks/tasks/main.yml
index 1ca666a49..2f06ad7f6 100644
--- a/ansible/roles/compatibility-checks/tasks/main.yml
+++ b/ansible/roles/compatibility-checks/tasks/main.yml
@@ -4,7 +4,7 @@
that:
- "ansible_version.full is version_compare('2.7', '>=')"
msg: >
- "Please use Ansible 2.7 or higher to install OpenAppStack."
+ "Please use Ansible 2.7 or higher to install Stackspin."
- name: cluster_dir variable is needed
assert:
diff --git a/ansible/roles/configure/files/README.md b/ansible/roles/configure/files/README.md
index ace06035a..509c38f27 100644
--- a/ansible/roles/configure/files/README.md
+++ b/ansible/roles/configure/files/README.md
@@ -1,14 +1,14 @@
-This directory contains information about the OpenAppStack instance running on
+This directory contains information about the Stackspin instance running on
this machine. For general information, see [https://stackspin.net].
## Flux
We use [Flux](https://fluxcd.io/) for keeping the applications that form
OpenAppstack up to date. Flux runs inside your cluster, regularly reads
-available updates from the central OpenAppStack repository, and upgrades your
+available updates from the central Stackspin repository, and upgrades your
applications accordingly, taking into account local configuration.
### Cluster-local configuration
Settings and secrets that are specific to your cluster (as opposed to other
-OpenAppStack instances) are stored in Kubernetes secrets.
+Stackspin instances) are stored in Kubernetes secrets.
diff --git a/ansible/roles/configure/files/oas-version-info.sh b/ansible/roles/configure/files/oas-version-info.sh
index 2203959e0..9c36645a2 100755
--- a/ansible/roles/configure/files/oas-version-info.sh
+++ b/ansible/roles/configure/files/oas-version-info.sh
@@ -1,6 +1,6 @@
#!/bin/bash -x
-cat /var/lib/OpenAppStack/version.txt
+cat /var/lib/Stackspin/version.txt
kubectl version
kubectl krew version
kubectl krew list
diff --git a/ansible/roles/configure/tasks/main.yml b/ansible/roles/configure/tasks/main.yml
index 36c53a349..67b58e895 100644
--- a/ansible/roles/configure/tasks/main.yml
+++ b/ansible/roles/configure/tasks/main.yml
@@ -61,7 +61,7 @@
# Source Stackspin addtions from .bashrc_stackspin
. /root/.bashrc_stackspin
-- name: Record OpenAppStack version info
+- name: Record Stackspin version info
tags:
- version
shell: "{{ item }}"
@@ -73,7 +73,7 @@
register: stackspin_version
changed_when: false
-- name: Create OpenAppStack version file
+- name: Create Stackspin version file
tags:
- version
template:
diff --git a/docs/comparable_projects.md b/docs/comparable_projects.md
index 8bfff5d70..81f9cf551 100644
--- a/docs/comparable_projects.md
+++ b/docs/comparable_projects.md
@@ -1,11 +1,11 @@
# Comparable projects
-Other open source projects similar to OpenAppStack exist. Each of the platforms
-listed here, like OpenAppStack, provide a suite of open source cloud
-applications. Each of the platforms, like OpenAppStack, include their own user
+Other open source projects similar to Stackspin exist. Each of the platforms
+listed here, like Stackspin, provide a suite of open source cloud
+applications. Each of the platforms, like Stackspin, include their own user
management dashboard and all of them offer single sign-on (SSO) features.
-However there are changes in implementation that make OpenAppStack different
+However there are changes in implementation that make Stackspin different
from these alternatives. As far as we found, none of the projects listed
below will automatically update your applications without you having to push a
button, for example.
@@ -21,19 +21,19 @@ With many users, this approach can run into limits.
management and user management system. As a result, Yunohost is relatively lightweight.
However, another result of this is that it is likely that if one of
the applications on your Yunohost contain a security hole, the data of the other
-applications is compromised as well. This is less likely in OpenAppStack because
+applications is compromised as well. This is less likely in Stackspin because
it separates the environments of applications from each other to seal them off.
**[Cloudron](https://cloudron.io)** offers a similar application suite. In
-contrast to OpenAppStack, Cloudron [requires a paid
+contrast to Stackspin, Cloudron [requires a paid
account](https://cloudron.io/pricing.html) if you want to use more than two
applications or more than five users.
All mentioned platforms require applications running on it to be changed in some
-way, for example to make use of the authentication system. OpenAppStack tries to
+way, for example to make use of the authentication system. Stackspin tries to
steer clear of changing the applications it includes. As long as they support
OpenID Connect, so you can sign into it, we can usually run the application
-as-is. In most cases, OpenAppStack will only need one intervention before an
+as-is. In most cases, Stackspin will only need one intervention before an
update can be pushed to users: it needs to be tested. We want to make sure that
an application works together with the platform and other applications before we
let you use it. We work towards a fully automated test suite, so even this would
diff --git a/docs/conf.py b/docs/conf.py
index 519ad5ae2..85ff4759e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,7 +17,7 @@
# -- Project information -----------------------------------------------------
-project = 'OpenAppStack'
+project = 'Stackspin'
copyright = '2020, Greenhost'
author = 'Greenhost'
diff --git a/docs/customizing.rst b/docs/customizing.rst
index 634e15800..80f02df7b 100644
--- a/docs/customizing.rst
+++ b/docs/customizing.rst
@@ -55,13 +55,13 @@ To apply it, run the following commands:
Adding custom apps to the cluster
=================================
-OpenAppStack uses Flux 2 to install and auto-update applications. If you want to
+Stackspin uses Flux 2 to install and auto-update applications. If you want to
install extra applications or other things into the Kubernetes cluster, our
advice would be to set up your own GitRepository and add it to the Flux system.
When you do this, you are fully responsible for keeping those applications
secure and updated. If any of those applications is insecure, that can also
-invalidate the security of your OpenAppStack applications, because they are part
+invalidate the security of your Stackspin applications, because they are part
of the same cluster and VPS.
Refer to the `Flux 2 documentation <https://fluxcd.io/docs>`__ for more
diff --git a/docs/design.md b/docs/design.md
index c10602942..f269aa08a 100644
--- a/docs/design.md
+++ b/docs/design.md
@@ -1,12 +1,12 @@
-OpenAppStack Design
+Stackspin Design
===================
-This article covers the basic design of OpenAppStack.
+This article covers the basic design of Stackspin.
## Application build pipeline
The following diagram explains the process to go from an application's source
-code to a deployment on OpenAppStack.
+code to a deployment on Stackspin.
@@ -59,14 +59,14 @@ overrides of the default application, as well as variables like the hostname
that the application will run on and listen to and the title of the web
interface.
-OpenAppStack will use Helm charts to provide the external configuration for the
+Stackspin will use Helm charts to provide the external configuration for the
"Deploy" step. Helm charts can contain configuration file templates with
default values that can be overridden during the installation or upgrade of a
helm chart.
## Application containers
-For inclusion in OpenAppStack, it is required that the application developers
+For inclusion in Stackspin, it is required that the application developers
provide Docker containers for their applications. There are several reasons for
this:
@@ -80,21 +80,21 @@ this:
### Container updates
When an application update is available, these updates need to be rolled out to
-OpenAppStack instances. This will be done according the following steps:
+Stackspin instances. This will be done according the following steps:
1. Application container is built with new application source and tagged for
testing.
4. Helm chart for application is updated to provide new container.
-3. Helm chart is deployed to an OpenAppStack test cluster following the steps in
+3. Helm chart is deployed to an Stackspin test cluster following the steps in
the diagram above.
2. Application is tested with automated tests
3. If tests succeed, new container is tagged for release.
-4. OpenAppStack automated update job fetches new Helm chart and upgrades current
+4. Stackspin automated update job fetches new Helm chart and upgrades current
instance using Helm.
Most of these steps can be developed by configuring a CI system and configuring
Kubernetes and Helm correctly. The automated update job that will run on
-OpenAppStack clusters will be developed by us.
+Stackspin clusters will be developed by us.
## Persistent data
@@ -109,21 +109,21 @@ application that requests it.
## Automatic updates
-OpenAppStack has an auto-update mechanism that performs unattended upgrades to
+Stackspin has an auto-update mechanism that performs unattended upgrades to
applications. [Flux 2](https://fluxcd.io/) is the system running in the cluster
that is responsible for these updates.
-Flux 2 tracks all the files in the `flux2` directory of the [OpenAppStack code
+Flux 2 tracks all the files in the `flux2` directory of the [Stackspin code
repository](https://open.greenhost.net/stackspin/stackspin). Once changes
are pushd the branch that Flux tracks, the changes are applied to the cluster.
-We use Flux 2 in "read only" mode, which means that your OpenAppStack cluster
+We use Flux 2 in "read only" mode, which means that your Stackspin cluster
does not push changes to our Git repository. You can read more about Flux 2 and
its components in the [flux 2 documentation](https://fluxcd.io/docs).
## APIs
-OpenAppStack includes several APIs that are available for some pieces of the
+Stackspin includes several APIs that are available for some pieces of the
software to talk to. Specifically the [Dashboard
application](https://open.greenhost.net/stackspin/admin-frontend) uses most
of these APIs.
diff --git a/docs/index.rst b/docs/index.rst
index 4d4f52114..c7078f255 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,26 +1,26 @@
-.. OpenAppStack documentation master file, created by
+.. Stackspin documentation master file, created by
sphinx-quickstart on Wed Jul 31 15:18:33 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to OpenAppStack's documentation!
+Welcome to Stackspin's documentation!
========================================
-OpenAppStack (OAS) is a platform that will offer self-managed, click-and-play
+Stackspin (OAS) is a platform that will offer self-managed, click-and-play
provisioning of online applications for Civil Society Organisations (CSOs).
-Users will be able to easily set up a self-hosted instance of OpenAppStack, so
+Users will be able to easily set up a self-hosted instance of Stackspin, so
they can keep control over the data that gets entered into these applications.
-OpenAppStack is:
+Stackspin is:
- Open Source
- Self updating
- Easy to deploy
- Integrated
-For more information, go to `the OpenAppStack website`_.
+For more information, go to `the Stackspin website`_.
-.. _the OpenAppStack website: https://stackspin.net
+.. _the Stackspin website: https://stackspin.net
.. toctree::
:maxdepth: 2
diff --git a/docs/installation/create_cluster.rst b/docs/installation/create_cluster.rst
index 25eee0786..58b5195b5 100644
--- a/docs/installation/create_cluster.rst
+++ b/docs/installation/create_cluster.rst
@@ -4,11 +4,11 @@
Create a kubernetes cluster
===========================
-This document describes how you can use OpenAppStack to install
+This document describes how you can use Stackspin to install
`k3s`_, a lightweight Kubernetes distribution on a virtual
private server.
-For OpenAppStack we will set up a "single-node" kubernetes cluster. This means
+For Stackspin we will set up a "single-node" kubernetes cluster. This means
everything runs on the same VPS. Support for "multi-node" clusters (a
Kubernetes cluster on more than one VPS) will come in the future.
@@ -38,7 +38,7 @@ Step 1: Create cluster configuration
====================================
To create a config for your cluster, use the ``create`` subcommand of the
-OpenAppStack CLI. First, choose a name (we chose ``stackspin.example.org``) for
+Stackspin CLI. First, choose a name (we chose ``stackspin.example.org``) for
your cluster. Then run the following command to get information about
the ``create`` subcommand:
@@ -50,12 +50,12 @@ If you want the installation script to automatically create a VPS for you, check
:ref:`setup-with-greenhost-api`.
Otherwise, continue here.
-If you want to install OpenAppStack on a non-Greenhost VPS, we assume
+If you want to install Stackspin on a non-Greenhost VPS, we assume
you already have a machine with a world-facing IP address. Make sure
that your VPS meets our `prerequisites <#prerequisites>`__. You'll need
its *hostname* and its *IP address*.
-Create the initial OpenAppStack configuration for your VPS by running the
+Create the initial Stackspin configuration for your VPS by running the
following command:
::
@@ -87,7 +87,7 @@ cluster. Create these two DNS records:
- A ``CNAME`` record ``*.stackspin.example.org`` pointing to ``stackspin.example.org``.
.. Note::
- It is also possible to host OpenAppStack on a domain (with
+ It is also possible to host Stackspin on a domain (with
no dedicated subdomain). That does imply that the included WordPress site
will be hosted on your root domain ``example.org``. In that case, make these
DNS records instead:
@@ -95,7 +95,7 @@ cluster. Create these two DNS records:
- An ``A`` record ``example.org`` pointing to the VPS's IP address,
- A ``CNAME`` record ``*.example.org`` pointing to ``example.org``.
-OpenAppStack will fetch https certificates with `Let's
+Stackspin will fetch https certificates with `Let's
Encrypt <https://letsencrypt.org>`__ by default. In order to do this DNS
entries need to be created.
@@ -104,7 +104,7 @@ entries need to be created.
Step 3: Create cluster
======================
-You're almost ready to start the OpenAppStack installation script.
+You're almost ready to start the Stackspin installation script.
First, make sure your DNS configuration is propagated. To do so, make
sure 'ping' shows your VPS's IP address:
@@ -116,7 +116,7 @@ The ``install`` command will try to log into your machine as the ``root``\ user
using SSH.
Run the ``install`` command with the CLI to completely configure your VPS for
-OpenAppStack.
+Stackspin.
::
diff --git a/docs/installation/install_oas.rst b/docs/installation/install_oas.rst
index cc7118cdb..57fd71eaf 100644
--- a/docs/installation/install_oas.rst
+++ b/docs/installation/install_oas.rst
@@ -1,20 +1,20 @@
.. _install_stackspin:
====================
-Install OpenAppStack
+Install Stackspin
====================
-This guide explains how to install OpenAppStack either on an existing Kubernetes
+This guide explains how to install Stackspin either on an existing Kubernetes
cluster that you have setup entirely yourself, or on a cluster you created
-following the OpenAppStack :ref:`create_kubernetes_cluster` guide.
+following the Stackspin :ref:`create_kubernetes_cluster` guide.
Please choose one of the below options:
.. tab-set::
- .. tab-item:: A. Install on cluster created with OpenAppStack cli
+ .. tab-item:: A. Install on cluster created with Stackspin cli
If you followed the :ref:`create_kubernetes_cluster` guide to setup a
- Kubernetes cluster using the OpenAppStack CLI tool you're all set and
+ Kubernetes cluster using the Stackspin CLI tool you're all set and
can continue by following the steps below.
.. tab-item:: B. Install on existing cluster
@@ -30,7 +30,7 @@ Please choose one of the below options:
- A single-node Kubernetes cluster
- A ``kube_config.yml`` file for API access
- **Configure DNS**: Please follow :ref:`configure_dns` how to setup the DNS records for OpenAppStack.
+ **Configure DNS**: Please follow :ref:`configure_dns` how to setup the DNS records for Stackspin.
**Setup**:
@@ -75,10 +75,10 @@ If you want apps like Nextcloud, RocketChat and Prometheus to be able to send
email notifications, you need to provide an email account.
.. Note::
- OpenAppStack does not set up an email server for you. In order to enable
+ Stackspin does not set up an email server for you. In order to enable
outgoing emails you need to provide an already existing email account.
-OpenAppStack uses SMTP to send emails. Search your email provider's helpdesk
+Stackspin uses SMTP to send emails. Search your email provider's helpdesk
for SMTP configuration details and enter them in the
``clusters/stackspin.example.org/.flux.env`` file as follows:
@@ -125,8 +125,8 @@ upload it to the S3 storage you configure. This includes:
consider not valuable enough to back up.
It does not include anything on the VPS that you may have set up but is not
-part of OpenAppStack, like programs installed via ``apt``, or data added to the
-VPS disk not through OpenAppStack.
+part of Stackspin, like programs installed via ``apt``, or data added to the
+VPS disk not through Stackspin.
To configure Velero, edit the file ``clusters/stackspin.example.org/.flux.env``,
and configure the settings with the ``backup_s3_`` prefix.
@@ -171,7 +171,7 @@ Next, run:
./install/install-stackspin.sh
-This installs the *core* of OpenAppStack into your cluster. To see what's
+This installs the *core* of Stackspin into your cluster. To see what's
included, check the ``flux2/infrastructure`` and the ``flux2/core`` folders in
the `git repository <https://open.greenhost.net/stackspin/stackspin>`__.
@@ -193,7 +193,7 @@ to install:
:ref:`backups-with-velero`).
When the installation scripts complete, the application installation may still
-be running on the OpenAppStack cluster. You can monitor the progress by running
+be running on the Stackspin cluster. You can monitor the progress by running
``flux get kustomizations`` (use ``watch flux get kustomizations`` to get
updates). If all kustomizations have been applied correctly, you can monitor
specific application releases by running ``watch flux get helmreleases
@@ -204,7 +204,7 @@ specific application releases by running ``watch flux get helmreleases
Step 3: Validate setup
======================
-Because OpenAppStack is still under development, we would like you to
+Because Stackspin is still under development, we would like you to
follow our `testing instructions <testing.html>`__ to make sure
that the setup process went well.
@@ -213,10 +213,10 @@ that the setup process went well.
Step 4: Let us know!
====================
-We would love to hear about your experience installing OpenAppStack. If you
+We would love to hear about your experience installing Stackspin. If you
encountered any problems, please create an issue in our `issue tracker
<https://open.greenhost.net/groups/stackspin/-/issues>`__. If you didn't
please still reach out as described on our `contact page
-<https://stackspin.net/contact.html>`__ and tell us how you like OpenAppStack
+<https://stackspin.net/contact.html>`__ and tell us how you like Stackspin
so far. We want to be in communication with our users, and we want to help you
if you run into problems.
diff --git a/docs/installation/overview.rst b/docs/installation/overview.rst
index 260bfde91..969558b50 100644
--- a/docs/installation/overview.rst
+++ b/docs/installation/overview.rst
@@ -5,12 +5,12 @@ Installation overview
=====================
.. warning::
- - OpenAppStack is still under heavy development and is not ready for
+ - Stackspin is still under heavy development and is not ready for
production use! We anticipate major changes and do not guarantee a
data-preserving upgrade path from current installations. However, we
- encourage you to try OpenAppStack and ask you to `report all issues
+ encourage you to try Stackspin and ask you to `report all issues
you encounter <https://stackspin.net/contact.html>`__.
- - When you install OpenAppStack on a server, the installation process
+ - When you install Stackspin on a server, the installation process
will make some substantial changes to the server's configuration, so
please do not use a server that functions as anything other than a
testing ground.
@@ -20,7 +20,7 @@ Installation overview
laptop. We call this the ``provisioning machine``.
All commands in these installation instructions need to be
run this provisioning machine that is *not* the server that will run
- OpenAppStack, unless specified otherwise.
+ Stackspin, unless specified otherwise.
Setup
=====
@@ -29,7 +29,7 @@ Common prerequisites
--------------------
Wether you want to create a kubernetes cluster first or want to install
-OpenAppStack on an existing cluster, these are the common prerequisites:
+Stackspin on an existing cluster, these are the common prerequisites:
- You need Python 3 with its development files, Pip and Git installed
(``apt install python3-pip python3-dev git`` on Debian)
@@ -38,10 +38,10 @@ OpenAppStack on an existing cluster, these are the common prerequisites:
sure we do not change any of your other projects. Install virtualenv
by running ``pip3 install --user venv`` or ``apt install python3-venv``.
-Clone the OpenAppStack git repository
+Clone the Stackspin git repository
-------------------------------------
-On your **provisioning machine**, clone the OpenAppStack git repository
+On your **provisioning machine**, clone the Stackspin git repository
and checkout the latest release branch (currently ``v0.7``):
::
@@ -69,17 +69,17 @@ second command "activates" the virtualenv.
Install requirements
--------------------
-Next, install the OpenAppStack CLI client by running the following
+Next, install the Stackspin CLI client by running the following
commands:
::
$ pip3 install -r requirements.txt
-OpenAppStack CLI client usage
+Stackspin CLI client usage
-----------------------------
-Now you can run the OpenAppStack CLI as follows:
+Now you can run the Stackspin CLI as follows:
::
diff --git a/docs/maintenance.rst b/docs/maintenance.rst
index 971dc2979..ef7bc7a32 100644
--- a/docs/maintenance.rst
+++ b/docs/maintenance.rst
@@ -137,15 +137,15 @@ On your provisioning machine
During the installation process, a cluster config directory is created
on your provisioning machine, located in the top-level sub-directory
``clusters`` in your clone of the stackspin git repository. Although
-these files are not essential for your OpenAppStack cluster to continue
+these files are not essential for your Stackspin cluster to continue
functioning, you may want to back this folder up because it allows easy
access to your cluster.
On your cluster
~~~~~~~~~~~~~~~
-OpenAppStack supports using the program Velero to make backups of your
-OpenAppStack instance to external storage via the S3 API. See
+Stackspin supports using the program Velero to make backups of your
+Stackspin instance to external storage via the S3 API. See
:ref:`backups-with-velero` in the installation instructions for setup details.
By default this will make nightly backups of the entire cluster (minus
Prometheus data). To make a manual backup, run
@@ -159,7 +159,7 @@ documentation`_ for more information.
Note: in case you want to make an (additional) backup of application
data via alternate means, all persistent volume data of the cluster are
-stored in directories under ``/var/lib/OpenAppStack/local-storage``.
+stored in directories under ``/var/lib/Stackspin/local-storage``.
Restore
-------
diff --git a/docs/reference.md b/docs/reference.md
index 7bf4d95c6..a7db0fc1a 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -5,11 +5,9 @@
During the installation process, the following files and directories are
created:
-- `/var/lib/OpenAppStack/local-storage`: all application data (e.g., Nextcloud
+- `/var/lib/Stackspin/local-storage`: all application data (e.g., Nextcloud
files) are stored here.
- `/var/lib/rancher/k3s`: this contains the files related to your "Kubernetes"
cluster.
- The kubectl configuration file is located at `/etc/rancher/k3s/k3s.yaml`
-
-
diff --git a/docs/requirements.in b/docs/requirements.in
index 30b09c857..16f51618f 100644
--- a/docs/requirements.in
+++ b/docs/requirements.in
@@ -3,7 +3,7 @@
# to update requirements.txt
#
# Please add developer dependencies which are not needed to install
-# OpenAppStack to requirements-dev.txt!
+# Stackspin to requirements-dev.txt!
#
sphinx
sphinx-design
diff --git a/docs/testing.rst b/docs/testing.rst
index d26985e05..bb45008ec 100644
--- a/docs/testing.rst
+++ b/docs/testing.rst
@@ -1,7 +1,7 @@
Testing guide
=============
-Great that you want to take OpenAppStack for a test drive !
+Great that you want to take Stackspin for a test drive !
This guide contains instructions to get you going, some pointers on what we think
would be useful to test, and guesses at what results of those tests
would be useful to write down. At any point please feel invited to test
@@ -17,7 +17,7 @@ domain name.
OAS installation
----------------
-First we’d like you to setup an OpenAppStack cluster by yourself,
+First we’d like you to setup an Stackspin cluster by yourself,
following the :ref:`installation_overview` and :ref:`usage:Usage` documentation and make sure
you complete all steps.
@@ -46,7 +46,7 @@ Nextcloud
Please browse to Nextcloud using the link from your user dashboard app
list and try to log in using single sign-on. Use the button labeled
-``Login with OpenAppStack``. Please try logging in with your admin
+``Login with Stackspin``. Please try logging in with your admin
account and configure the email settings as shown in the Usage doc.
After that please login with the user you created in the user panel.
@@ -119,4 +119,4 @@ issue <https://open.greenhost.net/stackspin/stackspin/issues/new>`__
using the ``Feedback`` template.
Thanks a lot for your testing work! We’ll use your input to try to
-improve OpenAppStack.
+improve Stackspin.
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
index f97fca786..3d629314a 100644
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -392,7 +392,7 @@ by telling Flux to *reconcile* them:
cluster$ flux reconcile helmrelease nextcloud
Will make sure that the Nextcloud ``helmrelease`` gets brought into a state that
-our OpenAppStack wants it to be in.
+our Stackspin wants it to be in.
Common installation failures
@@ -430,14 +430,14 @@ OAS installation in order to start from scratch:
.. warning::
- **You will lose all your data!** This completely destroys OpenAppStack and
+ **You will lose all your data!** This completely destroys Stackspin and
takes everything offline. If you chose to do this, you will need to
- re-install OpenAppStack and make sure that your data is stored somewhere
- other than the VPS that runs OpenAppStack.
+ re-install Stackspin and make sure that your data is stored somewhere
+ other than the VPS that runs Stackspin.
.. code:: bash
cluster$ /usr/local/bin/k3s-killall.sh
cluster$ systemctl disable k3s
- cluster$ rm -rf /var/lib/{rancher,OpenAppStack,kubelet} /etc/rancher /var/log/{OpenAppStack,containers,pods} /tmp/k3s /etc/systemd/system/k3s.service
+ cluster$ rm -rf /var/lib/{rancher,Stackspin,kubelet} /etc/rancher /var/log/{Stackspin,containers,pods} /tmp/k3s /etc/systemd/system/k3s.service
cluster$ systemctl reboot
diff --git a/flux2/apps/monitoring/kube-prometheus-stack-values-configmap.yaml b/flux2/apps/monitoring/kube-prometheus-stack-values-configmap.yaml
index 3fdd5b71e..479ad58d5 100644
--- a/flux2/apps/monitoring/kube-prometheus-stack-values-configmap.yaml
+++ b/flux2/apps/monitoring/kube-prometheus-stack-values-configmap.yaml
@@ -151,7 +151,7 @@ data:
server:
root_url: "https://grafana.${domain}"
auth.generic_oauth:
- name: OpenAppStack
+ name: Stackspin
enabled: true
client_id: grafana
client_secret: "${grafana_oauth_client_secret}"
diff --git a/flux2/apps/nextcloud/nextcloud-values-configmap.yaml b/flux2/apps/nextcloud/nextcloud-values-configmap.yaml
index 68261576b..0536119c5 100644
--- a/flux2/apps/nextcloud/nextcloud-values-configmap.yaml
+++ b/flux2/apps/nextcloud/nextcloud-values-configmap.yaml
@@ -205,4 +205,4 @@ data:
clientSecret: "${nextcloud_oauth_client_secret}"
groupsClaim: "stackspin_roles"
clientId: nextcloud
- title: OpenAppStack
+ title: Stackspin
diff --git a/flux2/apps/rocketchat/rocketchat-values-configmap.yaml b/flux2/apps/rocketchat/rocketchat-values-configmap.yaml
index 230c7dad4..1d5bb9c3a 100644
--- a/flux2/apps/rocketchat/rocketchat-values-configmap.yaml
+++ b/flux2/apps/rocketchat/rocketchat-values-configmap.yaml
@@ -51,7 +51,7 @@ data:
- name: Accounts_OAuth_Custom_Stackspin_login_style
value: redirect
- name: Accounts_OAuth_Custom_Stackspin_button_label_text
- value: Login via OpenAppStack
+ value: Login via Stackspin
- name: Accounts_OAuth_Custom_Stackspin_button_label_color
value: "#FFFFFF"
- name: Accounts_OAuth_Custom_Stackspin_button_color
diff --git a/flux2/apps/wordpress/wordpress-values-configmap.yaml b/flux2/apps/wordpress/wordpress-values-configmap.yaml
index b911244fe..a8f426cab 100644
--- a/flux2/apps/wordpress/wordpress-values-configmap.yaml
+++ b/flux2/apps/wordpress/wordpress-values-configmap.yaml
@@ -16,7 +16,7 @@ data:
# NOTE: Make sure you use underscore and that the localisation is in full caps
locale: en_US
url: "https://www.${domain}"
- title: "OpenAppStack website"
+ title: "Stackspin website"
persistence:
existingClaim: wordpress-files
diff --git a/flux2/core/base/single-sign-on/single-sign-on-values-configmap.yaml b/flux2/core/base/single-sign-on/single-sign-on-values-configmap.yaml
index 163c2b939..251e5af0e 100644
--- a/flux2/core/base/single-sign-on/single-sign-on-values-configmap.yaml
+++ b/flux2/core/base/single-sign-on/single-sign-on-values-configmap.yaml
@@ -23,7 +23,7 @@ data:
- name: &ROCKETCHAT rocketchat
description: "Communicate and collaborate using team chat and switch to video or audio calls with screen sharing for more efficient teamwork."
- name: &GRAFANA grafana
- description: "Grafana allows you to query, visualize, alert on and understand metrics generated by OpenAppStack. It can be used to create explore and share dashboards."
+ description: "Grafana allows you to query, visualize, alert on and understand metrics generated by Stackspin. It can be used to create explore and share dashboards."
- name: &WEKAN wekan
description: "Wekan Kanban board."
username: "${userbackend_admin_username}"
diff --git a/flux2/infrastructure/local-path-provisioner/local-path-provisioner-values-configmap.yaml b/flux2/infrastructure/local-path-provisioner/local-path-provisioner-values-configmap.yaml
index 630e4addd..eba402594 100644
--- a/flux2/infrastructure/local-path-provisioner/local-path-provisioner-values-configmap.yaml
+++ b/flux2/infrastructure/local-path-provisioner/local-path-provisioner-values-configmap.yaml
@@ -8,7 +8,7 @@ data:
nodePathMap:
- node: DEFAULT_PATH_FOR_NON_LISTED_NODES
paths:
- - "/var/lib/OpenAppStack/local-storage"
+ - "/var/lib/Stackspin/local-storage"
storageClass:
defaultClass: true
# We temporarily use our own build in order to use local volumes instead of
diff --git a/install/flux-version-check.sh b/install/flux-version-check.sh
index 2cbb2ed49..88cd01b60 100644
--- a/install/flux-version-check.sh
+++ b/install/flux-version-check.sh
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
if [ "$(flux --version)" != "flux version 0.20.1" ]; then
- echo "The OpenAppStack installation only works with Flux version 0.20.1"
+ echo "The Stackspin installation only works with Flux version 0.20.1"
exit 1
fi
diff --git a/openappstack/__main__.py b/openappstack/__main__.py
index bacb15e46..422b921ff 100755
--- a/openappstack/__main__.py
+++ b/openappstack/__main__.py
@@ -42,7 +42,7 @@ def main(): # pylint: disable=too-many-statements,too-many-branches,too-many-lo
- create, responsible for setting up VPSs and their local configuration
files
- - install, responsible for setting up Kubernetes and OpenAppStack on those
+ - install, responsible for setting up Kubernetes and Stackspin on those
VPSs
- test, responsible for testing if all the setup steps worked.
@@ -70,7 +70,7 @@ def main(): # pylint: disable=too-many-statements,too-many-branches,too-many-lo
create_parser.add_argument(
'domain',
metavar='DOMAIN_NAME',
- help='Domain name to run OpenAppStack under')
+ help='Domain name to run Stackspin under')
create_parser.add_argument(
'--create-hostname',
type=str,
@@ -152,7 +152,7 @@ def main(): # pylint: disable=too-many-statements,too-many-branches,too-many-lo
install_parser = subparsers.add_parser(
'install',
help=("Use this to run the ansible playbook that sets up your VPS to run "
- "OpenAppStack. The ansible-playbook process will run in the "
+ "Stackspin. The ansible-playbook process will run in the "
"'{ansible_path}' directory, so do not use relative paths with these "
"arguments.").format(ansible_path=ansible.ANSIBLE_PATH))
install_parser.set_defaults(func=install)
diff --git a/openappstack/ansible.py b/openappstack/ansible.py
index 5b11b3f17..1efeae4ef 100644
--- a/openappstack/ansible.py
+++ b/openappstack/ansible.py
@@ -1,5 +1,5 @@
"""
-Module responsible for running the Ansible part of the OpenAppStack setup.
+Module responsible for running the Ansible part of the Stackspin setup.
"""
import logging
import os
diff --git a/openappstack/cluster.py b/openappstack/cluster.py
index a12346ac8..a43ff19cd 100644
--- a/openappstack/cluster.py
+++ b/openappstack/cluster.py
@@ -1,4 +1,4 @@
-"""Contains code for managing the files related to an OpenAppStack cluster."""
+"""Contains code for managing the files related to an Stackspin cluster."""
import base64
import logging
diff --git a/requirements.in b/requirements.in
index f4bb163a1..67aa8bfc3 100644
--- a/requirements.in
+++ b/requirements.in
@@ -7,7 +7,7 @@
# See https://pypi.org/project/pip-tools/#updating-requirements for more.
#
# Please add developer dependencies which are not needed to install
-# OpenAppStack to requirements-dev.txt!
+# Stackspin to requirements-dev.txt!
# We need to update the mitogen plugin first in order to update to a newer
# ansible version
diff --git a/test/taiko/single-sign-on.js b/test/taiko/single-sign-on.js
index 93d533434..0d1ab1f22 100644
--- a/test/taiko/single-sign-on.js
+++ b/test/taiko/single-sign-on.js
@@ -36,7 +36,7 @@ const assert = require('assert');
if (taikoTests.includes('nextcloud') || taikoTests === 'all') {
console.log('• Nextcloud and Onlyoffice')
await click(link(below('nextcloud')))
- await click('Log in with OpenAppStack')
+ await click('Log in with Stackspin')
await click('Continue with ' + username)
// Close potential nextcloud first run wizard modal
@@ -57,7 +57,7 @@ const assert = require('assert');
// by email
// https://open.greenhost.net/stackspin/stackspin/-/issues/819
// await click(link(below('rocketchat')));
- // await click('Login via OpenAppStack');
+ // await click('Login via Stackspin');
// await click('Continue with ' + username)
}
@@ -77,7 +77,7 @@ const assert = require('assert');
console.log('• Grafana')
await goto(adminpanelUrl)
await click(link(below('grafana')))
- await click('Sign in with OpenAppStack')
+ await click('Sign in with Stackspin')
await click('Continue with ' + username)
await assert.ok(await text('Welcome to Grafana').exists());
}
--
GitLab