Merge pull request #7 from ByteInternet/update_documentation_and_codebase

Author: AlexanderGrooff

README.md

@@ -1,30 +1,30 @@
 # Hypernode Deploy Configuration
-These documentation is the guide to painlessly setup an automated deploy on the [Hipex B.V.](https://www.hipex.io/)
- platform.
+These documentation is the guide to painlessly setup an automated deploy on the [Hypernode](https://www.hypernode.com/) platform.
 The repository contains:
 
 - Configuration objects
 - Documentation
 
 ## Whats inside?
 - Deployer configuration hosts / tasks
-- Hipex server setup
+- Hypernode server setup
 - Email / New Relic notification
-- CloudFlare flush
+- Cloudflare flush
 
 ## Configuration
-1. Composer `require hipex/deploy-configuration --dev` package. Only needed when you want to have autocomplete in your `deploy.php`
+1. Composer `require hypernode/deploy-configuration --dev` package. Only needed when you want to have autocomplete in your `deploy.php`
 file.
 2. Copy the deploy templates inside the root of your project as `deploy.php`. You can find the template in
-[templates/deploy.php](./templates/deploy.php). 
-As you can see a `$configuration` variable is assigned a instance of a `Configuration` class. 
+[templates/deploy.php](./templates/deploy.php).
+As you can see a `$configuration` variable is assigned a instance of a `Configuration` class.
 This configuration object contains the whole deploy configuration and can be altered to your needs using getters/setters.
 Change configuration matching you use case, and refer to the documentation for other build in configurations and tasks.
 3. Setup your CI server
-    1.  GitLab CI [templates/.gitlab-ci.yml](./templates/.gitlab-ci.yml).
-    3.  Bitbucket [templates/bitbucket-pipelines.yml](./templates/bitbucket-pipelines.yml).
+    1. GitLab CI [templates/.gitlab-ci.yml](./templates/.gitlab-ci.yml).
+    2. Bitbucket [templates/bitbucket-pipelines.yml](./templates/bitbucket-pipelines.yml).
+    3. **Github Actions workflow coming soon!**
 4. For Magento 2 your first build will fail due to missing configuration. Login to the server and depending on your project file edit
-the `app/etc/env.php` or `app/etc/local.xml`. You will find these files in `~/domains/<domain>/application/shared/`.  
+the `app/etc/env.php` or `app/etc/local.xml`. You will find these files in `~/apps/<domain>/shared/`.
 
 ## Build steps
 
@@ -34,11 +34,13 @@ Builds the application to prepare to run in a production environment.
 
 You can define commands which needs to be executed during the build stage as follows:
 
-`$configuration->addBuildCommand(new \HipexDeployConfiguration\Command\Build\Composer())`
+``` php
+$configuration->addBuildCommand(new \Hypernode\DeployConfiguration\Command\Build\Composer());
+```
 
 This command will execute a `composer install` in your project folder install all project dependencies.
- 
-All possible commands can be found in the `HipexDeployConfiguration\Command\Build` namespace.
+
+All possible commands can be found in the `Hypernode\DeployConfiguration\Command\Build` namespace.
 Refer to the API docs for usage and options.
 
 This repository contains a few application templates which specifies the common tasks and their order to get the application build correctly.
@@ -50,64 +52,62 @@ Deploys the application which was build in the build stage to a given set of hos
 
 First you need to define your environments / infrastructure.
 
-```
-$stageAcceptance = $configuration->addStage('acceptance', 'acceptance.mydomain.com', 'my_ssh_username');
-$stageAcceptance->addServer('productionxxx.hipex.io', [
-    ServerRole::APPLICATION_FIRST,
-    ServerRole::APPLICATION,
-    ServerRole::LOAD_BALANCER,
-    ServerRole::VARNISH,
-    ServerRole::REDIS,
-]);
+``` php
+$stageAcceptance = $configuration->addStage('acceptance', 'acceptance.mydomain.com');
+$stageAcceptance->addServer('appname.hypernode.io');
 ```
 
 To set extra SSH options (https://www.ssh.com/academy/ssh/config) for your server you can also provide these.
 For example:
 
-```
+``` php
 $stage->addServer(
-    'productionxxx.hipex.io',
-    [ServerRole::APPLICATION],
+    'appname.hypernode.io',
+    [],
     [],
     ['LogLevel' => 'verbose']
+);
 ```
 
 You can define commands which needs to be executed during the deploy stage as follows:
 
-`$configuration->addDeployCommand(new \HipexDeployConfiguration\Command\Deploy\Magento2\CacheFlush())` 
+``` php
+$configuration->addDeployCommand(new \Hypernode\DeployConfiguration\Command\Deploy\Magento2\CacheFlush());
+```
 
-All possible commands can be found in the `HipexDeployConfiguration\Command\Deploy` namespace.
+All possible commands can be found in the `Hypernode\DeployConfiguration\Command\Deploy` namespace.
 Refer to the API docs for usage and options.
 
 ### 3. Provision Platform services / configurations
 
-Optionally you can have some services and application configurations setup automatically from your git repository to the Hipex platform
+Optionally you can have some services and application configurations setup automatically from your git repository to the Hypernode platform
 
 For example you could maintain your cron configuration in your GIT repository and have it automatically deployed to particular servers.
 
-```
-$configuration
-  ->addPlatformConfiguration(
-    (new \HipexDeployConfiguration\PlatformConfiguration\CronConfiguration())
+``` php
+$configuration ->addPlatformConfiguration(
+    (new \Hypernode\DeployConfiguration\PlatformConfiguration\CronConfiguration())
         ->setStage('production')
-  )
+);
 ```
 
 Or setup a varnish instance
 
-```
-$configuration->addPlatformService(new \HipexDeployConfiguration\PlatformService\VarnishService())
+``` php
+$configuration->addPlatformService(new \Hypernode\DeployConfiguration\PlatformService\VarnishService());
 ```
 
 For all possible tasks and configuration please refer to the API docs.
 
-### 4. AfterDeploy tasks
+### 3. AfterDeploy tasks
 
 After deploy tasks are triggered after a succesfull deployment.
 For example notifications are available.
 
 Usage:
-`$configuration->addAfterDeployTask(\HipexDeployConfiguration\AfterDeployTask\SlackWebhook())`
+``` php
+$configuration->addAfterDeployTask(new \Hypernode\DeployConfiguration\AfterDeployTask\SlackWebhook());
+```
 
 ## Application template
 
@@ -117,9 +117,10 @@ You could use those so you don't have to specify each task manually.
 Available templates:
 - Magento 1
 - Magento 2
+- Shopware 6
 
 Example usage:
-`$configuration = new Magento2('git@git.foo.bar:magento-2/project.git', ['nl'], ['nl'])`
+`$configuration = new Magento2('git@git.foo.bar:magento-2/project.git', ['nl_NL'], ['nl_NL'])`
 
 ## Required environment variables
 Some specific environment variables are required to allow the deploy image access to the git repository
@@ -129,44 +130,16 @@ or to be able to send out notifications.
 - `SSH_PRIVATE_KEY` Unencrypted SSH key. The key needs to have access to: main git repository, private packages
 and the SSH user. Must be base64 encoded like this:
 
-```bash
+``` bash
 cat ~/.ssh/deploy_key | base64
 ```
 
-## ServerRoles and Stages
-
-Servers are defined with a given set of server roles
-
-```
-$stage = $configuration->addStage('production', 'www.mydomain.com', 'my_ssh_username');
-$stage->addServer('production1.hipex.io', [
-    ServerRole::APPLICATION,
-]);
-$stage->addServer('production2.hipex.io', [
-    ServerRole::LOADBALANCER,
-]);
-```
-
-Most of the configurations can be specifically set for a given serverrole and/or stage.
-
-```
-$nginxConfiguration = (new NginxConfiguration('/etc/nginx/production'))
-  ->setServerRoles([ServerRole::APPLICATION])
-  ->setStage('production')
-$configuration->addPlatformConfiguration($nginxConfiguration)
-```
-
-This nginx configuration task will only be executed on production1, because this is the only one having server role `APPLICATION`
-
-Most tasks are assigned logical server roles already, so no need to specify them in those cases.
-
-
 ## Testing
 To test your build & deploy you can run your deploy locally.
 
 First make sure you have all the required env variables setup using.
 
-```bash
+``` bash
 export SSH_PRIVATE_KEY=***
 export DEPLOY_COMPOSER_AUTH=***
 .... etc
@@ -175,10 +148,10 @@ export DEPLOY_COMPOSER_AUTH=***
 Then start your build / deployment run command from root of the project.
 
 *repeat -e <ENV> for all env vars that are present during build*
-```bash
-docker run -it -e SSH_PRIVATE_KEY -e DEPLOY_COMPOSER_AUTH -v `pwd`:/build hipex/deploy hipex-deploy build -vvv 
+``` bash
+docker run -it -e SSH_PRIVATE_KEY -e DEPLOY_COMPOSER_AUTH -v `pwd`:/build hypernode/deploy hypernode-deploy build -vvv
 ```
 
-```bash
-docker run -it -e SSH_PRIVATE_KEY -e DEPLOY_COMPOSER_AUTH -v `pwd`:/build hipex/deploy hipex-deploy deploy acceptance -vvv 
+``` bash
+docker run -it -e SSH_PRIVATE_KEY -e DEPLOY_COMPOSER_AUTH -v `pwd`:/build hypernode/deploy hypernode-deploy deploy acceptance -vvv
 ```