Files
SSW590-DevOps/chapters/devopsIntroduction.tex

74 lines
3.9 KiB
TeX

\chapter{Introduction}
\ChapterLabel{Introduction}
\index{introduction}
\index{DevOps}
\index{scope}
\index{deliverables}
\section{Purpose}
This document records the configuration of the development environment used for
\CourseNumber\ and the working practices followed to produce it.
Each chapter covers one subject, and each assignment adds or revises chapters
as recorded in the document history. The latest revision for Assignment~\AssignmentNumber\
adds \ChapterRef{GiteaFoundation}, recording the Gitea deployment, HTTPS, firewall,
persistence testing, and team workflow.
Earlier coursework chapters are retained.
\section{Scope and Constraints}
\index{scope!constraints}
The following constraints apply to this revision.
\begin{itemize}[leftmargin=*]
\item The hosts chapter inventories the hosts in service and those still planned.
The cloud deployment chapter records the newly provisioned EC2 website and its actual configuration.
\item Linux Commands evidence was recorded locally under WSL. Assignment 3
deployment commands were executed on Ubuntu 26.04 on EC2. Supplied screenshots
distinguish those environments.
\item No credential, access token, private key, or account secret appears in
this document. Password rules are documented by derivation hint only, as
described in \ChapterRef{Passwords}.
\item This is a group submission. Chapters written before teams were formed
were prepared individually and are identified as such in the document history.
\item The document is authored in \LaTeX\ and compiled with pdf\LaTeX\ on
Overleaf. The board is hosted in GitHub Projects. The group deployment runs on Amazon EC2.
\end{itemize}
\section{Deliverables and Due Date}
\begin{tabularx}{\linewidth}{L{3.2cm}Y}
\toprule \textbf{Item} & \textbf{Expectation}\\ \midrule
Due date & \DueDate\\
Instructor & \Instructor\\
Team & \Author\\
Board & GitHub Projects, \texttt{SSW 590} (private; captured as figures in \ChapterRef{KanbanSetup})\\
Required deliverables & Compiled group manual with the eight Gitea rubric sections, configuration and test evidence, updated history, Hosts, and Passwords hints\\
Team policy & Group submission\\ \bottomrule
\end{tabularx}
\section{Document Organization}
\index{document organization}
\ChapterRef{KanbanSetup} describes the tool selected for the board, the steps
taken to configure it, the policy governing each column, and the inventory of cards.
\ChapterRef{Hosts} inventories the hosts in service and those planned, with their roles.
\ChapterRef{Passwords} defines the account and password rules for those hosts.
\ChapterRef{LinuxCommands} records the Linux working-directory setup and the problem-set solutions.
\ChapterRef{AIPromptLog} records AI assistance used in preparing this document.
\ChapterRef{CloudDockerDeployment} records the class-based Color Buttons website,
its container, and its deployment to Amazon EC2.
\ChapterRef{LatexDocker} records a TeX Live container that compiles \LaTeX\ documents
as Overleaf does.
\ChapterRef{ProjectProposal} proposes the course project and the DevSecOps tools it will compare.
This document is derived from the \CourseNumber\ assignment template credited on
the Template Attribution page. The template's instructional example chapter and
its template-maintenance appendices have been removed, since they describe how
to author the template rather than the environment this document records.
\ChapterRef{GiteaFoundation} records the persistent work hub, domain and DNS, HTTPS, firewall, persistence testing, and team workflow.
\section{Tools and AI Assistance}
\index{AI assistance}
AI assistance was used in preparing this document for drafting, review, and
troubleshooting. It was not used to generate results, command output, or
evidence of work that was not performed. Material assistance is recorded in
\ChapterRef{AIPromptLog} with the task, the inputs supplied, the output used,
and the corrections applied by the author.