Below is a complete walkthrough on how to set up and configure a new client Jira from start to finish, taking information from previously created pages and bringing it all under one place.
Where applicable, there will be links to previously used pages.
Create the client Jira container¶
Start with opening the terminal.
DON'T CLOSE THE TERMINAL AT ANY POINT!
Not until you are 100% sure Jira is ready. Also ensure you have "Limit Scrollback to" disabled (see image below) so that you can view all details required.
- Ssh into Cluster 2 by entering
ssh cluster2into the terminal.
- Change the directory with
Pick a client name for the Jira that is short but recognisable
- It'll be a good idea to input the command
containerListso that you have a list of names already in use.
- Normally we try aim for 4 or less characters.
- It'll be a good idea to input the command
You then need to input the following command, changing the "clientname" to the name you have chosen.
- For example:
bash .run.bash ecis what we might use for Edmonds Commerce.
bash ./run.bash clientname
- For example:
You will then see the terminal going through the script and eventually reach a point where it asks you the following:
Enter the number 1 in the terminal and press enter to continue.
When the script is finished, go to
jira.CLIENTNAME.edmondscommerce.net, replacing "CLIENTNAME" with the client name you assigned to the container earlier on.
REMEMBER, keep the terminal open!
Setting up the Jira database¶
Now that we have the container set up and you've followed the correct link, you should see the following in your browser.
- Click on "I'll set it up myself" and hit "Continue to MyAtlassian". You'll be taken to the database setup.
Scroll up in your terminal until you see the following.
Note: Using Shift+Ctrl+F and searching for "You can now access" will jump to the terminal lines you need.
Select MySQL 5.6 and enter the database details from the terminal in the corresponding fields in your Jira tab.
For the "Username" and "Password" entries at the bottom, you'll need to run another command in the terminal.
Open a new tab and do
sshContainer [containerName]to access the Jira container you made, and then do
cat ~/.my.cnf. This will display the following information below.
When all entries are done, hit "Test Connection". If you've entered the details correctly, you should see the following confirmation.
Upon confirmation, hit "Next".
Set Up Application Properties¶
On the next screen, enter the name of the client's Jira you are creating. For example, for Edmonds Commerce, we would call it "Edmonds Commerce Jira". For this page, we'll call it "Set Up Example Jira".
Make sure "Mode" is set to "Private" and keep the base URL the same.
Hit next when done.
Specify Your License Key¶
The next part of the set up requires assistance from the client. You'll need the License Key that the client obtained after they purchased Jira, but they will require the Server ID you see on this page in order to view it.
Head over to the client's shared folder on the google drive (or create one if needed) and create a folder called "Jira".
Inside the "Jira" folder, create a blank Google doc and call it "Access Details".
Inside the doc, enter "Server ID:" and "License Key:" and paste the Server ID as shown below.
The client will then need to paste the License Key into this document for us to use.
Send them an email explaining that we are setting up their Jira and that we require this key from them. They should already have access to the file you created since it's in a shared folder. If not, then share it with them. Below is an example of an email regarding this. The link the the article that we included above also has instructions on how to find the License Key in their Jira account.
I've started the set up for Jira and I'm now at the stage where I require the license key to continue.
You should have received an invitation to the shared Google folder I've put together for you.
Inside it, you'll find another folder called "Jira". Inside that folder is a file called "Access Details" where you will find the Server ID needed to receive the key.
When you have the key, please paste it into that same file and I'll pop in for it and continue the set-up.
You'll want to purchase the $10 license with no aditional products, which can be found here.
Feel free to check out the following page in our online handbook for a step-by-step walkthrough showing what you need to select on the purchase screen.
The link in the article that we included above also has instructions on how to find the License Key in their Jira account.
Once you receive an email from the client informing that they have added the Key to the doc, paste it into the box we saw earlier on and hit "Next".
Set up Administrator Account¶
On this page, we'll set up the "Admin" account for the Jira. Enter the fields with the following information shown below.
Note: Set the password to the current master password. If unsure, speak to admin team.
When done, hit "Next".
Set Up Email Notifications¶
Next, we'll be asked to configure outgoing emails.
This can be done later on in Jira, so for now, select "Later" and hit "Finish".
You'll then be asked which language you'll like to use with Jira.
Obviously, select "English (UK)". Hit "Continue" when ready.
Choose An Avatar¶
Since this is the admin account, we use the EC logo as our avatar. You can download a coy of it here.
- Click "Choose Avatar" and then navigate to where you downloaded the logo after clicking on "Choose file".
If that went through okay, resize the draggable box to it's full width then hit "Confirm".
Hit "Next" when done.
Unknown Server Error¶
Follow these steps below if you've received the following error after trying to upload the logo.
- Open the terminal and ssh to the Jira's container using
- Use the following command:
vim /opt/atlassian/jira/conf/server.xmlto open the config.
- You'll see the following lines of code, starting on line 31.
Add the following just under the last line, keeping within the corner brackets.
proxyname="jira.[client_name].edmondscommerce.net" proxyPort="443" scheme="https"
It should look like the following:
With that done, stay in the terminal and use the command
systemctl restart jirawhist still root.
This will restart the container and refresh the server config.
Wait for the command to finish and refresh your Jira page.
Log into Jira with the account information we created earlier on.
Select your language and follow the "Choose An Avatar" steps again.
Hit "Next" When done.
Create a New Project¶
Next, we'll need to create our first project.
1. Select "Create New Project" form the middle option.
2. Select "Kanban Board Development" from the window that appears and click on "Next" and then "Select" on the next window.
![Kanban Software Development](New-Jira-Setup-Images/Kanban-Software-Development.png)
- Next we need the name and Key for the project. If it's a Magento site we're working on, call it "Magento". If not, then name it after the client The key will be created automatically. Hit "Submit" when you're happy.
Live Jira Config¶
That's all the initial set up done for the new Jira! We now move onto configuring the live instance of Jira, giving it the functionality it requires.
New Jira Template Tasks¶
We follow an "Epic" task template when setting up the correct funcionality for these Jira.
Each time we create a new Jira, we need to copy this template, rename it accordingly to the Jira we're setting up and then follow each task.
You can find the template here.
Click on "More" and then click "Clone".
Replace "CLONE" with the Jira name, tick "Clone Links" and hit "Create".
You will be redirected to the new epic you've created in the issue viewer.
We need to make new tasks based off the ones in the template, so middle click to back button in your browser to open the template in a new tab.
Take the information from the tickets in the template and recreate them in the new Jira Epic. Below is the list of tasks in the template epic.
In the template epic, click on the "+" sign under "Issues in Epic" to add a task.