dbwebb-se/microblog

Example application for devops course

Microblog

Course material for a devops course, aimed at a Swedish course in computer science on University level new to devops. The students are to further develop this application and integreate it with new tools.

Released as part of a University course: https://dbwebb.se/kurser/devops

The application used in this course is based on The flask mega tutorial.

Dev environment

Here is how you setup the development environment and start the application.

Packages

Create a virtual environment and install packages:

python3 -m venv venv
source venv/bin/activate
make install-dev

If you are on Windows and Cygwin you will probably have troubles installing the pip package cryptography. Common errors are missing python.h, gcc, cffi and openssl.

Database

Setup SQLite database if migrations folder already exist:

flask db upgrade

If you have upgraded the code for any SQLAlchemy models:

flask db migrate -m '<message>'
flask db upgrade

You probably won't need to do this. But if you need to recreate app.db and migrations folder:

flask db init
flask db migrate -m '<message>'
flask db upgrade

If you have the wrong migrations version in the database when you want to upgrade it you can change it with:

flask db stamp head
flask db upgrade

Test application

There are several make commands for testing the application. Use make help to see which. To run all tests and validation use:

make test

Run application

Start byt setting the FLASK_APP and FLASK_ENV env vars:

export FLASK_APP=microblog.py
export FLASK_ENV=development

Change to use the DevConfig in microblog.py, uncomment # from app.config import DevConfig and # app = create_app(DevConfig) (comment app = create_app()).

Start the app with the following command and go to localhost:5000 in your browser.

flask run

Production environment

Follow the scripts in scripts/ or Driftsätta en flask app.

License

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.

Acknowledgement

This is a co-effort of several people using freely available documentation and tools from the open source community.

For contributors, see commit history and issues.

Feel free to help building up the repository with more content suited for training and education.

microblog's Issues

Fixa inför HT20

Kmom01

• Skriv av/om Miguel Guiden.
• bygg ut förel. med part 1 , the devops handbook.
• Många får inte upervisor konfigen att fungera. Kolla på att skapa log mappen.Gjort i script, kolla över artikeln.
• Skapa en roadmapp för vad de ska göra i kursmomenten, typ s.22+ i securing devops. Förklara valen av vekrtyg. Populära (, enkla) och opensource.
• styr upp hur de ska skapa sina ssh-nycklar (inget lösenord, inte .pem, namn aws)
• lägga till "export ANSIBLE_VAULT_PASSWORD_FILE=/.vault_pass.txt" i en "/. " fil
• ta bort "default" site i nginx.
• chmodda /var/log/microblog korrekt
• byt scp kommando till rsync

Fixa inför HT23

kmom01

• ersätt appen med en simpel todo/shoppinglista app. I flask eller svelte. Då blir det lättare att lägga till saker i koden. Att byta från python påverkar andra verktyg som används i kursen.

devops 1 och devops 2

Idee från en student att ha två devops kurser för att kunna få in ännu mer. nuvarande kurs är väldigt övergriplig och finns väldigt mycket som vi inte hinner ta upp.
Här kan vi såna om hur två kurs upplägget kan fungera.

Python django new project started and showing this error plz fix it

video_20220430_194228.mp4

Plz tell how to fix it

Changes to the ansible playbook

Two-factor authentication

If two-factor authentication is enabled for the Azure account, the ~/.azure/credentials login method cannot be used. Login is required to use the Azure CLI with az login. If the credentials file is present it takes presence over the CLI, causing login to fail.

DNS Zone

A DNS Zone is required to add DNS records for a domain.
In create_instance.yml:

-   name: Create a DNS Zone
    azure_rm_dnszone:
        resource_group: "{{ resource_group }}"
        name: "{{ domain_name }}"
        tags: "{{ vmtags }}"
        
-   name: Ensure "A" records for loadBalancer
    azure_rm_dnsrecordset:
...

In remove_instance.yml:

-   name: Delete a DNS Zone
    azure_rm_dnszone:
        resource_group: "{{ resource_group }}"
        name: "{{ domain_name }}"
        state: absent

Fixa inför HT23

Generellt
Har fått ny kursplan DV1673 oklart om den bärja gälla h23 eller h24

• om behåller samma koncept med föreläsningar, minska dem till 2h, så det bara är 1 timme efter föreläsningen.
• Ett intressant upplägg istället för att de ska jobba mot en server hela tiden hade varit att de ska göra teknisk demo/studie för varje typ av verktyg. Där de själva kan välja vilket de vill testa. Typ som denna https://github.com/blajban/vteam-rabbitmq.
  Då gör de det för varje kmom och samtidigt skriver ett stycke om hur det kopplas samman med devops. I slutet av kursen ska de göra ett litet projekt där de använder alla tekniker för att ta en app från dev till prod.
  Då kan jag ha en path-of-least resistance som emil har också.
• Nytt projekt? En enkel todo app? Kan skriva i js
• Apples nya M1 chip och docker har haft lite problem. De behöver bygga med ett annat kommando eller något. Kolla i discord eller om Malin/per skrev något specifikt i sina redovisningstexter.

kmom01

• gor om videor och texter då det är MFA och azur eistället för aws.
• bra förklaring av fördelar med devops automation, https://www.conjur.org/blog/devops-dishwasher/
• behöver kolla upp inlogg på azure via ansible i github actions med 2fa så det funkar i kmom03. https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure
• ersätt appen med en simpel todo/shoppinglista app. I flask eller svelte. Då blir det lättare att lägga till saker i koden. Att byta från python påverkar andra verktyg som används i kursen. hmm eller inte. Det är inte mycket kod i flask appen nu.... kanske bara borde gå igenom koden och se till att det funkar med senate python versionen.
• gör om "what is devops" videon. Dela upp den i flera mindre bitar istället för en lång. Få in bilden https://acn-marketing-blog.accenture.com/wp-content/uploads/2017/12/Accenture-Breaking-Development-Operations_1.jpg till nästa gång. Få in en bild på manufacturing plant, hur saker rör på sig
• Plocka bort ansible från dependencies. Och lägg till de i kmom03 på något sätt. Nu tar det sån jäkla tid för dem att installera saker som inte behövs.
• Flytta upp github education delen överst så att de börjar med att få sitt konto godkänt.

De flesta verkar nöjda med storleken på kmom01 och 02.

kmom02

• dynamiska taggar från Actions till Dockerhub.

      - name: Set docker tag
        run: echo "tag_name=$(cut -c2- <<< $GITHUB_REF_NAME)" >> $GITHUB_ENV
        ....
              push: true
              tags: andreasarne/microblog:${{ env.tag_name }}-prod

Fixa inför HT24

kmom01

• Bättre balansen mellan det praktiska och teoretiska. Nu är det för mycket. Blir kanske bättre med en kortare bok? och försöka minska/streamlina det praktiska.
• Byt ut boken? De tycker den är för woke och Amerikansk.
• Jobba med med storleken på kursmoment.
  """
  Jag tror att det hade varit bra att sträcka ut Kmom02 i över två
  veckor och slå ihop Kmom03 och Kmom05.
  """
• Försök slå ihop fler kmom så inte behöver rätta varje vecka
• gör en ordentlig föreläsning av The devops handbook?
• byt från debian till ubuntu på VMs?
• Bestäm igen att de ska ha siffra i versionen för kmomet. Nu har de inte det och det är förvirrande att veta var de är för.
• byt ut microblog mot https://github.com/PokeAPI/pokeapi/tree/master ?
• https://education.github.com/experiences/series_intro_github_flow

FIxa inför ht22

katacoda!!! https://www.oreilly.com/online-learning/leveraging-katacoda-technology.html
- alternativ: https://killercoda.com/ethos93/course/docker-k8s

kmom01

• Hitta nytt projekt att jobba med. Nu är det problem med outdated paket och kod.
• gör om taggningen. Nu har jag redan taggar med 1... 2... så de är "ivägen" för taggarna som studenterna ska göra.
• var tydlig med att de behöver minst python3.8
• Lägg till fusk texten på canvas.
• Emil sätter inte upp server längre i jsramverk, använder färdig lösning i azure, (Men han ska kanske gå tillbaka till det?). Kanske dags att fixa egna ordentliga instruktioner för setup och gihutb delarna?

Fixa inför HT21

kmom01

• Rekommendera att inte använda cygwin, WSL eller en linux VM.
• Förtydliga att de i circleci config ska använda make kommandona och inte pytest och flake8 kommandon från circleci guiden.
• Lägg till hur man cachar på requirements filen om det inte står i guiden.
  - save_cache:
  key: m2-{{ checksum "requirements/dev.txt" }}
  paths:
  - venv
  Epzillon@c82217c
• Gör det tydligare att de ska forka mitt repo? https://dbwebb.se/kunskap/introduktion_till_devops_appen#appen Någon behövde göra något två gpnger för att han inte visste att han skulle göra det.
• Visa hur de ska skapa SSH nycklar. "ssh-keygen -m PEM -t rsa -C "<[email protected]>", utan lösenord. Annars funkkar det inte på circleci. Skapa ny ssh nyckel via azure och ladda ner den. Den verkar funka i båda azure och circleci
• Problem med 2 tester i vissa miljöer oklart varför. löses med
  i tests/unit/models/test_user.py, för testerna test_password_hashing och test_avatar. ändra anropet.

# @mock.patch("app.models.current_app")
def test_password_hashing(test_app, user1):

gör samma sak för båda

• Unified commit meddelanden https://dev.to/timmybytes/keeping-git-commit-messages-consistent-with-a-custom-template-1jkm
  https://chris.beams.io/posts/git-commit/#seven-rules
  Footer kan vara kmom0x