Expedited virgin joomla

EXPEDITED VIRGIN DEPLOYMENT METHOD

PREBUILD NECESSITIES

If you don't already have a build machine running in the Linode cloud, follow these steps to get ready for the main build)

Begin by following this: Build Machine Setup

Following the steps in 1. will give you a build machine with access through the firewall for one machine (the laptop IP address that you provided).

EXPEDITED BUILD PROCESS

This will deploy the latest version of Joomla using template 1 which you can read about here: template 1 and the expedited method.

If you have followed these steps your build machine is online and secured and you have an SSH session open to it from your laptop through which to initiate your build processes.

We need several pieces of information from our cloud host and 3rd party services for a successful build to be possible:

I am going to use the example of joomla to build from and so this example will build a virgin installation of the latest version of joomla

To find the latest version of Joomla, I go to this URL in my browser:

Joomla Latest

And I note the latest version in a separate text file:

joomla_version="5.3.0"

You can of course use a legacy version of joomla also by choosing a different version numnber.

In production use you should use the principle of least privileges and have one key for DNS and one key for compute but here we will generate a single personal access token with ability to manipulate DNS records as well as compute and use the same key for both but in production you should have one PAT that just has DNS scope and one key which has scope for all your other needs.

Now record your access key and secret key in your separate text file on your laptop

linode_personal_access_token="20c698ca4f7e0338c4c886bc7bc8e6d86f6f2148b05c"

We now need to set up a key pair for Object Storage

Create a scratch bucket in order to active Object Storage if Object Storage is not already active on your account

Create access keys with UNLIMITED access to your current region (gb-lon)

Now record your Object Storage access keys in the text file on your laptop:

linode_object_storage_access_key="D0USS8R23RBK70TK"
linode_object_storage_secret_key="TqdUIUd3NuYSVd2MiZCFfPzXPXnoS"

You now need to make a note of the email address that you login to your exoscale account with:

linode_email="[email protected]"

You then need the url that you want to use for your website. If you don't have a DNS URL for your website, you need to purchase one and set the nameservers to exoscale as described here

linode_dns_name="www.drpatient.uk"

You then need to get an access key for your personal github account (you are advised to have a new separate github account for use with this toolkit)

Setting up a github account

Setting up personal access tokens for github

(your personal access token must have enough privileges to create repositories which means the "administrator" and "contents" options need to be set to read/write. Only setting these two values follows the principle of least privileges)

linode_github_username="adt-apps" #MANDATORY
linode_github_key="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k4" #MANDATORY

So, that should be all the core credentials that I need to make a deployment. I can save my text file now (and keep it secure) because I might want to use these credentials again for other deployments or redeployments.

So, at the command line of my build machine that we spun up earlier:

My chosen username is "wintersys-projects"

So, to begin an expedited build process, I need to:

cd /home/wintersys-projects/adt-build-machine-scripts/templatedconfigurations/templates/linode

Then we can open up the

vi linode1.tmpl

I then update all fields marked "MANDATORY" (marked in red) referring to the values that I have stored in the text file in my laptop in the correct template and when I am finished it looks like:

###############################################################################################
# Refer to: ${BUILD_HOME}/templatedconfigurations/specification.md
###############################################################################################
#This template is configured for virgin style builds

#####MANDATORY - Bare minimum set of values that you must provide for a build to have any chance of succeeding
#####NOT REQUIRED - isn't used by the Exoscale

#####Application Settings#########
export APPLICATION="joomla" #MANDATORY
export APPLICATION_IDENTIFIER="1" #MANDATORY
export JOOMLA_VERSION="5.3.0" #MANDATORY (depending on the above settings - a joomla deployment)
export DRUPAL_VERSION="" #MANDATORY (depending on the above settings - a drupal deployment)
export APPLICATION_BASELINE_SOURCECODE_REPOSITORY="JOOMLA:5.3.0" #MANDATORY
export BASELINE_DB_REPOSITORY="VIRGIN"
export APPLICATION_LANGUAGE="PHP"
export PHP_VERSION="8.4"
export BUILD_ARCHIVE_CHOICE="virgin"
export BUILD_CHOICE="0"
export APPLICATION_NAME="Demo Application"

#####S3 Datastore Settings#######
export S3_ACCESS_KEY="D0USS8R23RBK70TK" #MANDATORY
export S3_SECRET_KEY="TqdUIUd3NuYSVd2MiZCFfPzXPXnoS" #MANDATORY
export S3_HOST_BASE="gb-lon-1.linodeobjects.com"
export S3_LOCATION="US" #For exoscale, this always needs to be set to "US"
export DATASTORE_CHOICE="linode"
export DIRECTORIES_TO_MOUNT="" #This should always be unset for a virgin and baseline deployments
export PERSIST_ASSETS_TO_CLOUD="0" #This should always be set to 0 for a virgin and baseline deployment

#####OS Settings#########
export BUILDOS="debian" # One of ubuntu|debian
export BUILDOS_VERSION="12" # One of 20.04 22.04 24.04|10 11 12

######Cloudhost Provider Settings#######
export TOKEN="20c698ca4f7e0338c4c886bc7bc8e6d86f6f2148b05c" #MANDATORY
export S3_ACCESS_KEY="" #NOT REQUIRED
export S3_SECRET_KEY="" #NOT REQUIRED
export CLOUDHOST_ACCOUNT_ID="linode_username" #MANDATORY for Linode this should be your account username

######DNS Settings##########
export DNS_USERNAME="[email protected]" #MANDATORY
export DNS_SECURITY_KEY="20c698ca4f7e0338c4c886bc7bc8e6d86f6f2148b05c" #MANDATORY
export DNS_CHOICE="linode" #you will need to set your DNS nameservers according to this choice

#####Webserver Settings########
export WEBSITE_DISPLAY_NAME="Joomla Tutorial" #MANDATORY
export WEBSITE_NAME="drpatient" #MANDATORY
export WEBSITE_URL="www.drpatient.uk" #MANDATORY
export WEBSERVER_CHOICE="NGINX"
export NUMBER_WS="1"
export MAX_WEBSERVERS="10"

#####Git settings#####
export GIT_USER="Templated User"
export GIT_EMAIL_ADDRESS="[email protected]"

#####Infrastructure Repository Settings#######
export INFRASTRUCTURE_REPOSITORY_PROVIDER="github"
export INFRASTRUCTURE_REPOSITORY_OWNER="wintersys-projects"
export INFRASTRUCTURE_REPOSITORY_USERNAME="wintersys-projects"
export INFRASTRUCTURE_REPOSITORY_PASSWORD="none"

###### Application Repository Settings########
export APPLICATION_REPOSITORY_PROVIDER="github"
export APPLICATION_REPOSITORY_OWNER="adt-apps" #MANDATORY
export APPLICATION_REPOSITORY_USERNAME="adt-apps" #MANDATORY
export APPLICATION_REPOSITORY_PASSWORD="ghp_d51wi3xkDez6Mi53hypNm" #MANDATORY
export APPLICATION_REPOSITORY_TOKEN="ghp_d51wi3xkDez6Mi53hypNm" #MANDATORY

##### System Email Settings#########
export SYSTEM_EMAIL_PROVIDER=""
export SYSTEM_TOEMAIL_ADDRESS=""
export SYSTEM_FROMEMAIL_ADDRESS=""
export SYSTEM_EMAIL_USERNAME=""
export SYSTEM_EMAIL_PASSWORD=""
export EMAIL_NOTIFICATION_LEVEL="ERROR"

##### Database Settings######
export DB_PORT="2035"
export DATABASE_INSTALLATION_TYPE="Maria"
export DATABASE_DBaaS_INSTALLATION_TYPE=""
export BYPASS_DB_LAYER="0"

#####Server Settings #######
export REGION="ch-gva-2"
export DB_SERVER_TYPE="tiny"
export WS_SERVER_TYPE="tiny"
export AS_SERVER_TYPE="tiny"
export AUTH_SERVER_TYPE="tiny"
export CLOUDHOST="exoscale"
export MACHINE_TYPE="EXOSCALE"
export SSH_PORT="1035"
export SERVER_TIMEZONE_CONTINENT="Europe"
export SERVER_TIMEZONE_CITY="London"
export USER="root"
export SYNC_WEBROOTS="0"
export AUTHENTICATION_SERVER="0"
export USER_EMAIL_DOMAIN=""

#####Build Settings######
export PRODUCTION="0"
export DEVELOPMENT="1"
export BUILD_IDENTIFIER="tutorial" #MANDATORY
export NO_AUTOSCALERS="0"

#####Security Settings#####
export ACTIVE_FIREWALLS="3"
export PUBLIC_KEY_NAME="AGILE_TOOLKIT_PUBLIC_KEY"
export SSL_GENERATION_METHOD="AUTOMATIC"
export SSL_GENERATION_SERVICE="LETSENCRYPT"
export SSL_LIVE_CERT="1"
export ALGORITHM="rsa"
export BUILD_MACHINE_VPC="1"
export VPC_IP_RANGE="10.0.0.0/24"
export VPC_NAME="adt-vpc"

#####Build Style#######
export INPARALLEL="0"

If your template looks similar to the one I have provided here with all the fields marked in red having your custom values then you should be ready for deployment

${BUILD_HOME}/ExpeditedAgileDeploymentToolkit.sh

Note: because I haven't asked you to set up system emailing (to keep this tutorial as simple as possible) you will see these below messages during the deployment but you can safely ignore them it just means that there won't be any system emails sent for this deployment iteration.

IGNORE THESE IF YOU SEE THEM

Your value for the variable SYSTEM_EMAIL_PROVIDER () doesn't appear to be valid please review
It looks to me like the email address for the variable SYSTEM_TOEMAIL_ADDRESS () doesn't appear to be valid please review
It looks to me like the email address for the variable SYSTEM_FROMEMAIL_ADDRESS () doesn't appear to be valid please review

You will then need to answer the questions that you are asked and in a few minutes you should be able to install joomla using the GUI system of your browser. Please note, the credentials,port,database IP that you need to enter into the joomla GUI will be shown at the end of the build process.

When I ran the build process when writing this tutorial it looked as follows:

NOTE: In this image or this part of the output you will find the credentials you must set for your joomla application

NOTE: To display the joomla application you must go to your website URL in your browser such as https://www.topdog-insiders.uk/installation/index.php

Assuming that you have your Joomla application online that's this tutorial through.

What I would do if I wanted to build a Wordpress, Moodle or Drupal installation would be to follow the same procedure with the same template, but, minimally change the template as follows:

For Wordpress:

export APPLICATION="wordpress"
export APPLICATION_BASELINE_SOURCECODE_REPOSITORY="WORDPRESS" #MANDATORY 
export APPLICATION_IDENTIFIER="2"

For Drupal:

export APPLICATION="drupal"
export DRUPAL_VERSION="11.0.1" 
export APPLICATION_BASELINE_SOURCECODE_REPOSITORY="DRUPAL:11.0.1" #MANDATORY 
export APPLICATION_IDENTIFIER="3"

For Moodle:

export APPLICATION="moodle"
export APPLICATION_BASELINE_SOURCECODE_REPOSITORY="MOODLE" #MANDATORY 
export APPLICATION_IDENTIFIER="4"

So, you have a template now that you can use over and over again for deploying different installations of these CMS systems. You can study the spec and learn how to modify the template in order to change machine sizes, regions, PHP settings and so on.