Rafaela Alimentos | Capacitación técnica - Sesión 1 (2023-09-19)

Introduction and Development Environment

In this section, the speaker introduces the topic by discussing the development environment and tools used in their current project.

Introduction to Development Environment

• Ivan Silverstein, the DevOps lead, explains his role in maintaining repositories, automating deployments, monitoring servers, and collaborating with his colleague Joaquin.

• Tools used focus on standardizing libraries, versions of Odoo (Release), and configurations among developers to address issues like installation delays and library discrepancies.

• The primary tool discussed is WSL (Windows Subsystem for Linux), enabling a Linux console within Windows for seamless development. This integration with Docker facilitates creating consistent environments for testing and development.

Tools Utilized: Docker and Visual Studio Code

This section delves into the tools utilized in the project, emphasizing Docker for environment consistency and Visual Studio Code as the preferred IDE.

Docker Integration

• WSL combined with Docker allows for generating images mirroring production servers' configurations to ensure uniformity across development teams.

• Docker simplifies environment setup by defining a base image from existing server setups, streamlining development processes.

Visual Studio Code Usage

• Visual Studio Code is highlighted as the leading IDE due to its popularity among developers. It streamlines repository management and aids in focusing solely on coding tasks without distractions.

• Leveraging Makefiles simplifies tasks like library installations and system setup through predefined commands executed with ease.

Understanding Odoo Framework

This segment provides insights into Odoo's framework utilizing Python and XML for database operations within a Linux-based environment.

Odoo Framework Basics

• Odoo utilizes Python, XML, PostgreSQL as its core technologies within a Linux ecosystem focused on open-source solutions.

• The framework follows an MVC (Model View Controller) architecture inspired by web application programming models like Flask but tailored to streamline application development without reinventing common functionalities.

Functionality Overview

• Odoo simplifies database interactions by converting records into objects using ORM principles. This approach enables developers to focus on application logic rather than intricate database operations.

Detailed Overview of Module Structure and Architecture

In this section, the speaker discusses the structure of a module, including its manifest file and basic folders. Additionally, an overview of the typical architecture involving three servers is provided.

Module Structure

• The module will have a manifest file that specifies details such as file locations, module name, description, and icon. This information helps in organizing different files within the module.

• Modules consist of folders for models, views (in XML), controllers (Python), and potentially static files like HTML and CSS.

Architecture Setup

• A common architecture setup involves distributing services across three servers: one for the database, another for the application server (where code runs), and a third server acting as a reverse proxy using tools like Nginx to enhance web request handling.

• Each service ideally operates on its own virtual machine with dedicated resources like CPU, RAM, and storage to optimize performance and security.

Version Control System and Repository Workflow

This part covers the importance of version control systems like GitLab for collaborative development in a cloud-based environment. It explains branching strategies, requests for collaboration, approvals process, commits, naming conventions, and maintaining code stability.

Version Control System Basics

• GitLab is highlighted as a cloud-based collaborative development platform facilitating project management, version control, issue tracking, continuous deployment capabilities.

• Emphasizes the significance of well-designed workflows to ensure organization in development processes by tracking changes made by users at specific times.

Repository Workflow

• Conceptualizing repositories as cloud folders with associated databases storing all changes made by users over time.

• Branching off from the main branch (often called Master) allows parallel developments without affecting production code until changes are thoroughly tested.

Committing Changes

• Requesting collaboration involves creating a merge request where approvers review proposed changes before merging them into the main branch.

• Commits generate snapshots of changes approved through a unique hash signature stored in the repository's historical database.

Maintaining Code Stability with Naming Conventions

This segment delves into maintaining code stability through descriptive naming conventions within version control systems. It elaborates on using user IDs or ticket numbers along with clear descriptions for branches to enhance traceability.

Naming Conventions Importance

• Descriptive naming conventions aid in identifying contributors (user IDs) or tasks (ticket numbers) associated with specific branches for clarity during collaboration.

Branch Naming Strategy

• Utilizing user IDs or ticket numbers followed by concise descriptions when creating branches ensures easy reference back to tasks or issues being addressed within development cycles.

Effective Workflow Management Strategies

Here we explore workflow management strategies employed in current development practices focusing on maintaining stable code versions tagged for production releases while ensuring continuous integration with new features.

Workflow Implementation

• Current workflow entails maintaining a stable main branch housing tested code versions marked by tags indicating readiness for production deployment.

Tagging Releases

Detailed Overview of Development Processes

In this section, the speaker discusses the importance of communication to avoid conflicts when multiple developers are working on the same module.

Importance of Communication in Development

• Conflict resolution is crucial when two developments are working on the same module but not the same file.

• Communication alerts developers about conflicts during processes like pushing changes from Master to a new fixture.

Utilizing Mechanisms for Code Stability

The discussion shifts towards utilizing mechanisms for code stability and maintaining a clear history of changes.

Ensuring Code Stability and Clear History

• Both fixes and fixtures use similar mechanisms: branching off Master, making changes, and then merging back to Master.

• Maintaining a clear history of changes leads to a cleaner database and easier issue detection.

Ensuring Quality Through Testing

The focus is on quality assurance through static code tests before merging changes.

Quality Assurance Practices

• Pull requests trigger alerts to configured reviewers for approval before merging into Master.

• Static code tests ensure proper formatting, variable usage, library imports, enhancing code quality significantly.

Importance of Local Configuration and Version Control

Emphasizing local configuration setup for testing before pushing changes to servers.

Local Configuration Benefits

• Local configuration with pre-commit tests enhances code quality before pushing changes to servers.

• Version control maintains a comprehensive project version history in a single branch, aiding in clear integration timelines.

Best Practices in Repository Management

Highlighting best practices such as avoiding direct changes to Master without proper verification.

Repository Management Best Practices

• Prohibiting direct changes to Master without approvals ensures code integrity and review processes adherence.

• Maintaining descriptive branch names and updating branches with Master regularly prevents conflicts from parallel developments.

Detailed Overview of Technical Concepts

In this section, the speaker delves into technical aspects related to database setup, configuration files, and Docker functionalities.

Database Setup and Configuration Files

• The database is well-configured with various infrastructure elements that should not be altered. It is crucial to understand how these components work together efficiently.

• Configuration files for pre-commit tests are essential for automatically running code formatting checks and detecting unused variables. These configurations ensure code quality and consistency.

• Exception handling in configuration files helps identify issues that may arise during project development, prompting code improvements. Docker-related files play a significant role in ensuring the environment functions optimally.

Docker Functionality and Simplified Commands

• A single make file streamlines tasks by defining commands through tags like 'build' or 'help,' simplifying complex operations such as setting up environments or executing specific actions.

• Using straightforward commands like 'precommit install' eases the installation of pre-commit tests, allowing developers to focus on Python development without unnecessary complexities.

Streamlining Development with Docker

This segment emphasizes the efficiency gained by focusing on Python development within a streamlined Docker environment.

Efficient Development Workflow

• Developers can concentrate on Python solution development as the groundwork for efficient coding practices is already established within Docker configurations.

• Continuous feedback from team members aids in addressing specific needs within the Docker image creation process, ensuring a tailored approach to project requirements.

Utilizing Docker Files for Image Creation

Exploring the intricacies of creating images using Docker files and their impact on project deployment.

Image Creation Process

• Detailed insights into crafting a Docker file reveal its functionality in building images based on specified requirements, such as installing necessary tools and dependencies.

• The step-by-step installation process outlined in a Docker file showcases how each component is added systematically to generate a complete image ready for deployment.

Seamless Integration with WSL

Discussing the seamless integration between Linux and Windows through Windows Subsystem for Linux (WSL).

WSL Integration Benefits

• Leveraging WSL eliminates the need for virtual machines, providing an efficient platform for running Linux distributions directly on Windows systems.

Detailed Installation Process

In this section, the speaker explains the detailed process of installation, emphasizing the ease and speed of creating and reinstalling images.

Installation Process

• The speaker mentions deleting and recreating a small image disk quickly using a command.

• Installing involves creating a user with a password similar to setting up Ubuntu for the first time.

• Emphasizes the quick and efficient nature of the installation process.

Introduction to Visual Studio Code

This part introduces Visual Studio Code as a widely used open-source code editor known for its simplicity and extensive extension library.

Visual Studio Code Features

• Visual Studio Code is highlighted as one of the most utilized code editors due to its open-source nature.

• The editor is praised for its user-friendly interface and abundance of available extensions.

• Available on Windows, Mac, and Linux platforms, making it versatile for various users' needs.

Utilizing Extensions in Visual Studio Code

The discussion shifts towards utilizing an extension that enhances functionality within Visual Studio Code when working with WSL.

Extension Usage

• Mention of an extension recommendation from repositories to facilitate seamless integration with WSL.

• Highlights the ability to work on Windows but connect remotely as if operating within WSL environment.

Exploring Docker Functionality

Docker's functionality is explained, focusing on replicating production environments efficiently while managing persistent data effectively.

Docker Functionality

• Docker aims to replicate production setups by isolating servers into separate containers.

• Emphasizes the concept of persistent data within containers while allowing disposable container instances for easy recreation.

Understanding Volumes in Docker

The importance of volumes in Docker is discussed, enabling users to maintain specific data while modifying other aspects freely.

Volume Management

• Introduces volumes as a method to preserve essential data like databases across container restarts.

Linux Docker and Make Tool Overview

In this section, the speaker discusses Linux Docker, its popularity, and the use of the Make tool for command execution.

Linux Docker

• Docker is the most famous and widely used open-source Linux container.

• Docker allows for lightweight, isolated application deployment.

• It is portable and can be easily set up using a declarative file specifying the environment requirements.

Make Tool

• The Make tool serves as a recipe book for command execution in the command line.

• Docker Compose files define services, volumes, network ports, facilitating easy setup of complex systems like microservices configurations.

Utilizing Make Tool with Docker

This section delves into utilizing the Make tool in conjunction with Docker for streamlined operations.

Learning Curve Simplification

• Learning to use Make and basic commands reduces reliance on advanced Docker knowledge.

• Accessing pre-written commands in Make files eliminates the need to memorize complex commands.

Practical Application

• Creating images, containers, restoring databases are simplified tasks using predefined commands in Make files.

Enhancing Development Efficiency with Make Tool

The discussion focuses on leveraging the Make tool for efficient development processes within a containerized environment.

Real-time Monitoring

• Using 'make log' displays real-time logs aiding in debugging and monitoring activities within containers.

Scripting Capabilities

• 'Make Bash' provides access to container Linux environments for scripting purposes such as backup generation or process automation.

New Section

In this section, the speaker discusses setting up a new system from scratch and registering it.

Setting Up a New System

• The process involves starting everything from scratch and potentially creating a new registration.

New Section

This part focuses on using the Windows command line to demonstrate certain actions.

Utilizing Windows Command Line

• Demonstrates using the classic cmd in Windows for various tasks.

New Section

The speaker explores different options available in Windows for installation purposes.

Exploring Installation Options

• Discusses utilizing Windows features like Ubuntu and Oracle for security testing.

New Section

Installing Ubuntu as a separate distribution for specific use cases is highlighted here.

Installing Ubuntu Distribution

• Sets up Ubuntu as a separate version for distinct purposes, showcasing the ease of installation.

New Section

Emphasizing the importance of having Docker Desktop installed for future work is discussed in this segment.

Importance of Docker Desktop

• Stresses the necessity of having Docker Desktop installed before proceeding with further tasks.

New Section

Providing essential links and resources for downloading WSL (Windows Subsystem for Linux) is covered here.

Downloading WSL Resources

Detailed Technical Instructions

In this section, technical instructions are provided regarding permissions and machine settings.

Permissions and Machine Settings

• A discussion about permissions and requests for permission on a machine.

• Emphasizing the importance of not needing to be an administrator for certain tasks.

• Mentioning issues with a specific command that may not be functioning correctly.

Installation Process Walkthrough

This part covers the installation process demonstration and troubleshooting steps.

Installation Process Demonstration

• Demonstrating the installation process with screen sharing.

• Exploring full-screen options during installation.

• Providing an alternative method for installing WSL through the Microsoft Store.

Utilizing Command Line Tools

The focus here is on utilizing command line tools effectively post-installation.

Command Line Tool Usage

• Steps to access and utilize specific versions through the Microsoft Store.

• Running commands within WSL from Windows environment.

• Introducing a user-friendly terminal application for enhanced usability.

Customization and Configuration

Customization options and configuration settings are discussed in this segment.

Customization Options

• Configuring Ubuntu as the default profile in the terminal.

• Setting up profiles for easier access to multiple terminals simultaneously.

Navigating File Systems

Navigating file systems within WSL is explained along with directory creation processes.

File System Navigation

• Creating directories within user folders for project management.

Installation Process Overview

In this section, the speaker discusses the installation process for various tools required for development, including configurations and necessary steps.

Installation Steps

• Setting up installations through chat to save time and ensure all components are installed together.

• Providing a link for installing Visual Studio Code and emphasizing the importance of remembering passwords during installation.

• Installing essential tools like Make via console commands to enable command functionalities.

• Introducing the Remote SSH extension in Visual Studio Code for remote execution.

• Addressing space management issues in virtual disks by compacting disk images with specific commands.

Configuration and Extension Setup

This part focuses on additional configurations, extensions, and troubleshooting tips related to the development environment setup.

Configuration Details

• Highlighting the existence of solutions for space management issues within virtual disks.

• Initiating code download within a specific folder to ensure proper functionality of Remote SSH.

• Demonstrating plugin download processes and ensuring correct installation for seamless operation.

Repository Cloning and Extension Recommendations

The speaker delves into repository cloning procedures, extension recommendations, and automated installations for enhanced development workflows.

Repository Management

• Planning to clone repositories with a list of recommended extensions for streamlined operations.

• Discussing ongoing installations while addressing potential conflicts that may arise during the process.

Extension Installation Guidance

Providing guidance on installing extensions efficiently within the development environment.

Extension Installation Steps

• Directing users to install the Remote SSH extension seamlessly through step-by-step instructions.

Final Configuration Steps

Concluding configuration steps before proceeding with further setup requirements.

Final Setup Instructions

Configuring End of Line (EOL) in Windows and Linux

The speaker discusses configuring the End of Line (EOL) settings in Windows and Linux, highlighting the differences in line break encoding between the two operating systems.

Configuring EOL Settings

• In Windows, the End of Line (EOL) encoding differs from that in Linux, even though it is invisible to users.

• Notifications are removed to provide a clear command console interface without distractions.

• Editing files and navigating through commands are demonstrated without clutter at the bottom.

• Accessing file preferences and configurations is crucial for setting EOL preferences effectively.

• The process involves adjusting EOL settings by entering 'eol' to configure line break encoding.

Finalizing Configuration

The final steps involve completing the configuration process for optimal synchronization.

Completing Configuration

• After adjusting EOL settings, all participants confirm their progress in configuring preferences accurately.