Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

compose based deployment docs #4

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/docker_compose_up.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/jenkins_credentials-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/jenkins_plugins_install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/samagra_arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 7 additions & 24 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,32 +36,15 @@ import DocsCards from '@components/global/DocsCards';

</DocsCards>

## Overview
## Welcome to the DevOps guide!

Your project's overview
Whether you're a startup or a large enterprise, your ability to deliver software quickly, reliably, and securely is critical to your success. That's where DevOps comes in.

### Sub Heading -1
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
DevOps is a set of practices that combines development and operations teams to work together in a more agile, collaborative, and automated way.

At SamagraX, we're passionate about adopting DevOps practices and improve the software delivery capabilities. In this guide, we'll explore the key concepts, tools, and processes that make up a successful DevOps strategy. Whether you're just getting started with DevOps or looking to improve your existing practices, this guide will provide practical tips and best practices to help you achieve your goals.

### Sub Heading -2
Let's get started with the guide.

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."


## Appflow

Your App Flow

## Ecosystem

Your App's Ecosystem

### Join the Community

There are millions of Ionic developers in over 200 countries worldwide. Here are some ways to join:


## License

Your Project license
## Architecture
![SamagraX DevOps Pipeline Architecture](./assets/samagra_arch.png)
41 changes: 41 additions & 0 deletions docs/setup/compose_based.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Compose Based Deployment
---

<head>
<title>Environment Setup</title>
<meta
name="description"
content="Here we'll deploy our pipeline in the Docker Container"
/>
</head>

Here we'll deploy our pipeline in the Docker Container using compose.

## Pre-requisites:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These pre-requisites are wrong. we only need docker-compose, docker and make for this. Not jenkins vault etc.

- Docker and Docker Swarm for running the compose services
- Make cli for running Makefile

## Setting up the Pipeline
- ### **Clone the repository**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove every instruction associated with vault, jenkins etc. We don't need to install them.

```
git clone https://github.com/SamagraX-RCW/devops.git
```

- ### **Run the scripts to install Docker and Docker Compose**
```
chmod +x ./scripts/setup.sh
./scripts/setup.sh
```

- ### **Now run the compose file to deploy Registry, Nginx and Vault**
```
docker compose up -d
```

![Docker Compose image](../assets/docker_compose_up.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only this step is needed after the pre-requisites are met.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay


- ### **Start RCW Services**
```
make start
```
4 changes: 2 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ module.exports = {
type: 'category',
label: 'Getting Started',
collapsed: false,
items: ['index']
items: ['index'],
},
{
type: 'category',
label: 'Setup',
collapsed: false,
items: ['setup/swarm_based']
items: ['setup/compose_based', 'setup/swarm_based'],
},

],
Expand Down