cf69197a44
Apparently we've reached the limit of GitHub rendering (512K). Time to change the structure accordingly - exercises and questions will move to sub-directories in the exercises directory. This is the first patch in performing this transition.
306 lines
14 KiB
Markdown
306 lines
14 KiB
Markdown
## CI/CD
|
|
|
|
### CI/CD Exercises
|
|
|
|
|Name|Topic|Objective & Instructions|Solution|Comments|
|
|
|--------|--------|------|----|----|
|
|
| Set up a CI pipeline | CI | [Exercise](ci_for_open_source_project.md) | | |
|
|
| Deploy to Kubernetes | Deployment | [Exercise](deploy_to_kubernetes.md) | [Solution](solutions/deploy_to_kubernetes/README.md) | |
|
|
| Jenkins - Remove Jobs | Jenkins Scripts | [Exercise](remove_jobs.md) | [Solution](solutions/remove_jobs_solution.groovy) | |
|
|
| Jenkins - Remove Builds | Jenkins Sripts | [Exercise](remove_builds.md) | [Solution](solutions/remove_builds_solution.groovy) | |
|
|
|
|
### CI/CD Self Assessment
|
|
|
|
<details>
|
|
<summary>What is Continuous Integration?</summary><br><b>
|
|
|
|
A development practice where developers integrate code into a shared repository frequently. It can range from a couple of changes every day or a week to a couple of changes in one hour in larger scales.
|
|
|
|
Each piece of code (change/patch) is verified, to make the change is safe to merge. Today, it's a common practice to test the change using an automated build that makes sure the code can integrated. It can be one build which runs several tests in different levels (unit, functional, etc.) or several separate builds that all or some has to pass in order for the change to be merged into the repository.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What is Continuous Deployment?</summary><br><b>
|
|
|
|
A development strategy used by developers to release software automatically into production where any code commit must pass through an automated testing phase. Only when this is successful is the release considered production worthy. This eliminates any human interaction and should be implemented only after production-ready pipelines have been set with real-time monitoring and reporting of deployed assets. If any issues are detected in production it should be easy to rollback to previous working state.
|
|
|
|
For more info please read [here](https://www.atlassian.com/continuous-delivery/continuous-deployment)
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Can you describe an example of a CI (and/or CD) process starting the moment a developer submitted a change/PR to a repository?</summary><br><b>
|
|
|
|
There are many answers for such a question, as CI processes vary, depending on the technologies used and the type of the project to where the change was submitted.
|
|
Such processes can include one or more of the following stages:
|
|
|
|
* Compile
|
|
* Build
|
|
* Install
|
|
* Configure
|
|
* Update
|
|
* Test
|
|
|
|
An example of one possible answer:
|
|
|
|
A developer submitted a pull request to a project. The PR (pull request) triggered two jobs (or one combined job). One job for running lint test on the change and the second job for building a package which includes the submitted change, and running multiple api/scenario tests using that package. Once all tests passed and the change was approved by a maintainer/core, it's merged/pushed to the repository. If some of the tests failed, the change will not be allowed to merged/pushed to the repository.
|
|
|
|
A complete different answer or CI process, can describe how a developer pushes code to a repository, a workflow then triggered to build a container image and push it to the registry. Once in the registry, the k8s cluster is applied with the new changes.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What is Continuous Delivery?</summary><br><b>
|
|
|
|
A development strategy used to frequently deliver code to QA and Ops for testing. This entails having a staging area that has production like features where changes can only be accepted for production after a manual review. Because of this human entanglement there is usually a time lag between release and review making it slower and error prone as compared to continous deployment.
|
|
|
|
For more info please read [here](https://www.atlassian.com/continuous-delivery/continuous-deployment)
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What is difference between Continuous Delivery and Continuous Deployment?</summary><br><b>
|
|
|
|
Both encapsulate the same process of deploying the changes which were compiled and/or tested in the CI pipelines.<br>
|
|
The difference between the two is that Continuous Delivery isn't fully automated process as opposed to Continuous Deployment where every change that is tested in the process is eventually deployed to production. In continuous delivery someone is either approving the deployment process or the deployment process is based on constraints and conditions (like time constraint of deploying every week/month/...)
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What CI/CD best practices are you familiar with? Or what do you consider as CI/CD best practice?</summary><br><b>
|
|
|
|
* Commit and test often.
|
|
* Testing/Staging environment should be a clone of production environment.
|
|
* Clean up your environments (e.g. your CI/CD pipelines may create a lot of resources. They should also take care of cleaning up everything they create)
|
|
* The CI/CD pipelines should provide the same results when executed locally or remotely
|
|
* Treat CI/CD as another application in your organization. Not as a glue code.
|
|
* On demand environments instead of pre-allocated resources for CI/CD purposes
|
|
* Stages/Steps/Tasks of pipelines should be shared between applications or microservices (don't re-invent common tasks like "cloning a project")
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>You are given a pipeline and a pool with 3 workers: virtual machine, baremetal and a container. How will you decide on which one of them to run the pipeline?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Where do you store CI/CD pipelines? Why?</summary><br><b>
|
|
|
|
There are multiple approaches as to where to store the CI/CD pipeline definitions:
|
|
|
|
1. App Repository - store them in the same repository of the application they are building or testing (perhaps the most popular one)
|
|
2. Central Repository - store all organization's/project's CI/CD pipelines in one separate repository (perhaps the best approach when multiple teams test the same set of projects and they end up having many pipelines)
|
|
3. CI repo for every app repo - you separate CI related code from app code but you don't put everything in one place (perhaps the worst option due to the maintenance)
|
|
4. The platform where the CI/CD pipelines are being executed (e.g. Kubernetes Cluster in case of Tekton/OpenShift Pipelines).
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How do you perform plan capacity for your CI/CD resources? (e.g. servers, storage, etc.)</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How would you structure/implement CD for an application which depends on several other applications?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How do you measure your CI/CD quality? Are there any metrics or KPIs you are using for measuring the quality?</summary><br><b>
|
|
</b></details>
|
|
|
|
#### CI/CD - Jenkins
|
|
|
|
<details>
|
|
<summary>What is Jenkins? What have you used it for?</summary><br><b>
|
|
|
|
Jenkins is an open source automation tool written in Java with plugins built for Continuous Integration purpose. Jenkins is used to build and test your software projects continuously making it easier for developers to integrate changes to the project, and making it easier for users to obtain a fresh build. It also allows you to continuously deliver your software by integrating with a large number of testing and deployment technologies.
|
|
|
|
Jenkins integrates development life-cycle processes of all kinds, including build, document, test, package, stage, deploy, static analysis and much more.
|
|
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What are the advantages of Jenkins over its competitors? Can you compare it to one of the following systems?
|
|
|
|
* Travis
|
|
* Bamboo
|
|
* Teamcity
|
|
* CircleCI</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What are the limitations or disadvantages of Jenkins?</summary><br><b>
|
|
|
|
This might be considered to be an opinionated answer:
|
|
|
|
* Old fashioned dashboards with not many options to customize it
|
|
* Containers readiness (this has improved with Jenkins X)
|
|
* By itself, it doesn't have many features. On the other hand, there many plugins created by the community to expand its abilities
|
|
* Managing Jenkins and its piplines as a code can be one hell of a nightmare
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Explain the following:
|
|
|
|
- Job
|
|
- Build
|
|
- Plugin
|
|
- Node or Worker
|
|
- Executor</summary><br><b>
|
|
- Job is an automation definition = what and where to execute once the user clicks on "build"
|
|
- Build is a running instance of a job. You can have one or more builds at any given point of time (unless limited by confiugration)
|
|
- A worker is the machine/instance on which the build is running. When a build starts, it "acquires" a worker out of a pool to run on it.
|
|
- An executor is variable of the worker, defining how many builds can run on that worker in parallel. An executor value of 3 means, that 3 builds can run at any point on that executor (not necessarily of the same job. Any builds)
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What plugins have you used in Jenkins?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Have you used Jenkins for CI or CD processes? Can you describe them?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What type of jobs are there? Which types have you used?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How did you report build results to users? What ways are there to report the results?</summary><br><b>
|
|
|
|
You can report via:
|
|
* Emails
|
|
* Messaging apps
|
|
* Dashboards
|
|
|
|
Each has its own disadvantages and advantages. Emails for example, if sent too often, can be eventually disregarded or ignored.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>You need to run unit tests every time a change submitted to a given project. Describe in details how your pipeline would look like and what will be executed in each stage</summary><br><b>
|
|
|
|
The pipelines will have multiple stages:
|
|
|
|
* Clone the project
|
|
* Install test dependencies (for example, if I need tox package to run the tests, I will install it in this stage)
|
|
* Run unit tests
|
|
* (Optional) report results (For example an email to the users)
|
|
* Archive the relevant logs/files
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How to secure Jenkins?</summary><br><b>
|
|
|
|
[Jenkins documentation](https://www.jenkins.io/doc/book/security/securing-jenkins/) provides some basic intro for securing your Jenkins server.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Describe how do you add new nodes (agents) to Jenkins</summary><br><b>
|
|
|
|
You can describe the UI way to add new nodes but better to explain how to do in a way that scales like a script or using dynamic source for nodes like one of the existing clouds.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How to acquire multiple nodes for one specific build?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Whenever a build fails, you would like to notify the team owning the job regarding the failure and provide failure reason. How would you do that?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>There are four teams in your organization. How to prioritize the builds of each team? So the jobs of team x will always run before team y for example</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>If you are managing a dozen of jobs, you can probably use the Jenkins UI. But how do you manage the creation and deletion of hundreds of jobs every week/month?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What are some of Jenkins limitations?</summary><br><b>
|
|
|
|
* Testing cross-dependencies (changes from multiple projects together)
|
|
* Starting builds from any stage (although Cloudbees implemented something called checkpoints)
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What is the different between a scripted pipeline to declarative pipeline? Which type are you using?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How would you implement an option of a starting a build from a certain stage and not from the beginning?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Do you have experience with developing a Jenkins plugin? Can you describe this experience?</summary><br><b>
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>Have you written Jenkins scripts? If yes, what for and how they work?</summary><br><b>
|
|
</b></details>
|
|
|
|
#### CI/CD - GitHub Actions
|
|
|
|
<details>
|
|
<summary>What is a Workflow in GitHub Actions?</summary><br><b>
|
|
|
|
A YAML file that defines the automation actions and instructions to execute upon a specific event.<br>
|
|
The file is placed in the repository itself.
|
|
|
|
A Workflow can be anything - running tests, compiling code, building packages, ...
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What is a Runner in GitHub Actions?</summary><br><b>
|
|
|
|
A workflow has to be executed somewhere. The environment where the workflow is executed is called Runner.<br>
|
|
A Runner can be an on-premise host or GitHub hoste
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What is a Job in GitHub Actions?</summary><br><b>
|
|
|
|
A job is a series of steps which are executed on the same runner/environment.<br>
|
|
A workflow must include at least one job.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>What is an Action in GitHub Actions?</summary><br><b>
|
|
|
|
An action is the smallest unit in a workflow. It includes the commands to execute as part of the job.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>In GitHub Actions workflow, what the 'on' attribute/directive is used for?</summary><br><b>
|
|
|
|
Specify upon which events the workflow will be triggered.<br>
|
|
For example, you might configure the workflow to trigger every time a changed is pushed to the repository.
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>True or False? In Github Actions, jobs are executed in parallel by deafult</summary><br><b>
|
|
|
|
True
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How to create dependencies between jobs so one job runs after another?</summary><br><b>
|
|
|
|
Using the "needs" attribute/directive.
|
|
|
|
```
|
|
jobs:
|
|
job1:
|
|
job2:
|
|
needs: job1
|
|
```
|
|
|
|
In the above example, job1 must complete successfully before job2 runs
|
|
</b></details>
|
|
|
|
<details>
|
|
<summary>How to add a Workflow to a repository?</summary><br><b>
|
|
CLI:
|
|
|
|
1. Create the directory `.github/workflows` in the repository
|
|
2. Add a YAML file
|
|
|
|
UI:
|
|
|
|
1. In the repository page, click on "Actions"
|
|
2. Choose workflow and click on "Set up this workflow"
|
|
</b></details>
|