Create Blog “open-sourcing-workshops-on-demand-part-2-how-to-deploy-the-infrastructure” #3175
Conversation
…he-infrastructure”
✅ Deploy Preview for hpe-dev-portal ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
There was a problem hiding this comment.
Hi Frederic,
Thank you so much for the rework of the part 2 of the series.
I have added a few comments for your consideration.
Dale will review the blog post when time permits.
You may want to use the style below for bullet items:
Tips #16 (global Style)
https://github.com/hpe-dev-incubator/hpe-dev-portal/blob/master/docs/ContributorGuide-v2.md#tips-and-trick-using-the-cms-editor
|
|
||
|  | ||
|
|
||
| ## How to deploy your own Workshops-on-Demand infrastructure... |
There was a problem hiding this comment.
Suggestion: maybe remove the ... at the end of the header.
|
|
||
| ## How to deploy your own Workshops-on-Demand infrastructure... | ||
|
|
||
| As explained in the previous [article](https://developer.hpe.com/blog/willing-to-build-up-your-own-workshops-on-demand-infrastructure/), the project is split into multiple repositories from the architectural and public / private aspects. Since the publication if of the previous article, additionnal repositories showed up as the installation process evolved over time. The architecture is divided between the frontend, api-db, and backend. The project admins will need to decide whether they are willing to develop and propose public-only content to the participants or add any proprietary and private content. |
There was a problem hiding this comment.
Some suggestions for your consideration (I highlighted in bold my suggestions).
Second sentence:
Since the publication if of the previous article, additionnal repositories showed up as the installation process evolved over time.
--> Since the publication of the previous article, additional repositories showed up as the installation process evolved over time.
3rd sentence:
The architecture is divided between the frontend, api-db, and backend.
--> The architecture is divided between the frontend, database API (db API or API-db), and backend.
4th sentence:
The project admins will need to decide whether they are willing...
--> The project administrators will need to decide whether they are willing
|
|
||
| ### Public-only Deployment: No private backend nor private workshops | ||
|
|
||
| **Important Note:** |
There was a problem hiding this comment.
Suggestion:
Important note with the sentence in the same line:
Important Note: This part is compulsory for any type of deployment. Public only or public + private.
|
|
||
| Here's a quick look at what can be found in each: | ||
|
|
||
|  |
There was a problem hiding this comment.
The image is blurry. Maybe try to get a better resolution image.
| * An Ansible engine to allow automation | ||
| * A fail2ban service | ||
| * An Admin user to manage everything | ||
| * A set of scripts to handle different tasks such as: |
There was a problem hiding this comment.
Not sure why in the preview, the sentence "A set of scripts to handle different tasks such as:"
have a line space.
|
|
||
| The principle remains similar, with a few differences explained below. | ||
|
|
||
| * After cloning the wod-install repository, you will fork the following public private [repo](https://github.com/Workshops-on-Demand/wod-private.git) on Github under your own Github account (we will refer to it as `Account`). |
| * Next, clone the forked repo. | ||
| * Edit the `all.yml` and `<groupname>` files to customize your setup. This variable `<groupname>` defines possible backend server in your environement. By default, the project comes with a sample working file named `production` in `ansible/group-vars`. But you could have multiple. In our case, we have defined `sandbox`, `test`, `staging` and several `production` files, all defining a different backend environment. These files will be used to override the default values specified by the public version delivered as part of the default public installation. | ||
| * Commit and push changes to your repo. | ||
| * Create an `install.priv` file located in `install` directory when using a private repo (consider looking at [install.repo](https://github.com/Workshops-on-Demand/wod-backend/blob/main/install/install.repo) file for a better understanding of the variables). |
There was a problem hiding this comment.
the link to "Install repo" gives a 404 error.
Please check.
| * Edit the `install.priv` file located in `install` directory of wod-install: | ||
|
|
||
| * Create line before variable declaration: ``token=`cat $EXEPATH/token` `` | ||
| * Use the token in the url WODPRIVREPO="git clone https://user:[email protected]/Account/wod-private.git wod-private" |
There was a problem hiding this comment.
The git clone hotlink gives 404 error
Please check.
|
|
||
| Please note that this setup phase can be concurrent with the public setup phase. Indeed, the install script should detect the presence of the private repository owing to the presence of the install.priv file. It will automatically adjust the different scripts and variables to add the relevant content. It will actually overload some of the variables with private ones. | ||
|
|
||
| You now have a working Workshops-on-Demand backend server in place. Congratulations! The next article in the series will help you better understand the lifecycle of the backend server. How does a workshop registration work from the backend server 's side? How do you manage this server on a daily basis? How and when do you need to update it ? All these questions will be answered in the next article. And from there, we will move to the frontend side of things and finally to a workshop's creation process. |
There was a problem hiding this comment.
Suggest to add a line space before the:
The next article in the series will help you better understand the lifecycle of the backend server. How does a workshop registration work from the backend server 's side? How do you manage this server on a daily basis? How and when do you need to update it ? All these questions will be answered in the next article. And from there, we will move to the frontend side of things and finally to a workshop's creation process.
|
|
||
| If you need support for this installation process, use our dedicated [slack channel](https://hpedev.slack.com/archives/C01B60X8SSD). | ||
|
|
||
| Please be sure to check back [HPE Developer blog site](https://developer.hpe.com/blog) to read all the articles in this series. Also, check out the Hack Shack for new [workshops](https://developer.hpe.com/hackshack/workshops) [Data Visualization 101](https://developer.hpe.com/hackshack/replays/42) is now available! Stay tuned for additional Workshops-on-Demand in our catalog. No newline at end of file |
There was a problem hiding this comment.
Not sure I fully understand the sentence "workshops" and "data visualization 101":
Also, check out the Hack Shack for new workshops Data Visualization 101 is now available! Stay tuned for additional Workshops-on-Demand in our catalog.
Maybe, separate the sentences as follows:
Also, check out the Hack Shack for new workshops.
The workshop Data Visualization 101 is now available! Stay tuned for additional Workshops-on-Demand in our catalog.
2 participants
Automatically generated by Netlify CMS