You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Added example for the `--label` option
- Added example for the `--clear-services` option
- Added `clear_services` setting to Hypernode Deploy example
- Replaced some occurences of "Hypernode-deploy" with "Hypernode Deploy"
- Replaced occurences of `testalex` with `example`
- Replaced some occurences of `appname` with `example`
Copy file name to clipboardExpand all lines: docs/hypernode-platform/tools/hypernode-brancher.md
+42-20Lines changed: 42 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,13 +100,13 @@ The appname specified in the request url is the appname on which the Brancher no
100
100
101
101
Once the Brancher node becomes available, you can control it via the `/v2/app/<appname>-eph123456` endpoint just like a regular Hypernode.
102
102
103
-
### Hypernode-deploy
103
+
### Hypernode Deploy
104
104
105
-
Hypernode-deploy is our recommended way of deploying your webshop to Hypernode. which makes it easier for you to manage your application’s codebase. This platform is fully integrated with Hypernode Brancher, which makes it a breeze for you to try out upgrade scenarios, or pushes to the Staging environment.
105
+
Hypernode Deploy is our recommended way of deploying your webshop to Hypernode. which makes it easier for you to manage your application’s codebase. This platform is fully integrated with Hypernode Brancher, which makes it a breeze for you to try out upgrade scenarios, or pushes to the Staging environment.
106
106
107
-
Once you set up your Hypernode to make use of Hypernode-deploy, you can run your tests against a Brancher node with just a single command. This will then run against your fresh Branched version of the Node, making sure that your tests are passing before deploying to production.
107
+
Once you set up your Hypernode to make use of Hypernode Deploy, you can run your tests against a Brancher node with just a single command. This will then run against your fresh Branched version of the Node, making sure that your tests are passing before deploying to production.
108
108
109
-
You can use Brancher in your Hypernode-deploy deploy.php file like this:
109
+
You can use Brancher in your Hypernode Deploy `deploy.php` file like this:
This will automatically create a Brancher node based on the parent Hypernode and push to it, allowing you to test the changes before making them on the production Hypernode.
129
+
This will automatically create a Brancher node based on the parent Hypernode and push to it, allowing you to test the changes before making them on the production Hypernode. In this example, we also clear services `cron` and `supervisor`, which means that the `cron` and `supervisor` configurations found on `example` will not be actively present on the Brancher instance.
130
+
131
+
```{note}
132
+
There's an alias `hypernode-brancher` for the command `hypernode-systemctl brancher`, this might save you some keystrokes :).
133
+
```
130
134
131
135
### Hypernode-systemctl brancher
132
136
133
-
You can use the command hypernode-systemctl brancher tool to quickly interact with the Hypernode API in a validated and controlled manner. Creating a Brancher node goes like this:
137
+
You can use the command hypernode-systemctl brancher tool to quickly interact with the Hypernode API in a validated and controlled manner.
138
+
139
+
#### Creating a Brancher node
134
140
135
141
```console
136
142
$ hypernode-systemctl brancher --create
137
-
Brancher App created for app 'testalex'. See hypernode-systemctl brancher --list for the progress
138
-
app_name: testalex-eph123456
139
-
parent: testalex
140
-
Host: testalex-eph123456.hypernode.io
143
+
Brancher App created for app 'example'. See hypernode-systemctl brancher --list for the progress
144
+
app_name: example-eph123456
145
+
parent: example
146
+
Host: example-eph123456.hypernode.io
147
+
Labels: None
148
+
Services with data to be cleared: cron
141
149
IP: will become available in a couple of minutes
142
150
```
143
151
144
-
You can then list the available Brancher nodes:
152
+
In the above example you see the details of the created Brancher instance. The output also contains the given labels and services to be cleared, which have the respective defaults of `None` and `cron`.
153
+
154
+
To apply one or more label(s) to the Brancher instance, you can specify one or more `--label` options when creating the instance:
0 commit comments