https://github.com/mindfiredigital/firekubex

This script streamlines Kubernetes deployment for developers via a config.yaml file. Abstracting complexity, it enables swift application deployment without deep Kubernetes expertise. Support includes start/stop services, and dev/prod modes.
https://github.com/mindfiredigital/firekubex

Last synced: about 2 months ago
JSON representation

This script streamlines Kubernetes deployment for developers via a config.yaml file. Abstracting complexity, it enables swift application deployment without deep Kubernetes expertise. Support includes start/stop services, and dev/prod modes.

• Host: GitHub
• URL: https://github.com/mindfiredigital/firekubex
• Owner: mindfiredigital
• Created: 2023-12-04T09:12:58.000Z (about 1 year ago)
• Default Branch: dev
• Last Pushed: 2024-01-11T11:51:26.000Z (12 months ago)
• Last Synced: 2024-01-11T19:05:41.119Z (12 months ago)
• Language: Python
• Size: 70.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kubernetes Deployment Script Documentation

## Introduction

This documentation provides an overview of a Python script that simplifies the process of deploying applications to a Kubernetes cluster. With this script, developers can deploy their applications without requiring in-depth knowledge of Kubernetes. The script takes a configuration file (`config.yaml`) as input, generates Kubernetes resources (Deployment, Service, ConfigMap), and deploys the application to the cluster.

## Prerequisites

Before using this script, ensure you have the following prerequisites:

- Python 3.x installed

- `kubectl` command-line tool installed and configured to work with your Kubernetes cluster

- Dockerfiles for the applications you want to deploy

## Configuration

### `config.yaml`

The `config.yaml` file is the main configuration file for the script. You should provide the following information for each application you want to deploy:

- `version`: The script version (currently 3.2).

- `service`: A dictionary containing information about each application. You can configure multiple applications in this section. For each application, provide the following details:

  - `image`: The Docker image address for the application.

  

  - `name`: The name of the application, which will be used as the namespace in Kubernetes.

  - `port`: The port on which the application should listen.

  - `ContainerPath`: The path within the container where the application files are stored.

  - `ServiceLocalPath`: The local path on the host machine where the application files are stored.

  - `ReplicaSet`: The number of replicas you want for the application (optional).

  - `configmaps`: Configuration settings for the application. You can specify environment variables and their values here.

  - `tags`: Tags or labels for the application (optional).

### `core.yaml`

For core services, you can use a separate `core.yaml` file with the same structure as `config.yaml`. This allows you to configure core services separately.

## Usage

The script provides several command-line options:

- `--dev`: Use this option to deploy applications in development mode with a replica set of 1.

- `--prod`: Use this option to deploy applications with the replica set specified in the `config.yaml` file.

- `--start `: Start a specific service by providing its name. You can also use `--start all` to start all services.

- `--stop `: Stop a specific service by providing its name.

- `--core`: Use this option to parse and apply services from `core.yaml`.

## Deployment Workflow

1. Run the script with the desired options. For example, to start a specific service, use the `--start` option with the service name.

   ```bash

   python start.py --start 

## Example

Suppose you have a config.yaml file with the configuration for your application. To deploy the application in development mode, use the following command:

    ```bash

    python start.py --dev

## Notes

- The Dockerfile for each application must be present in the source code repository.

- This script is designed to work with various Kubernetes setups, including both cloud and on-premises clusters.

## Conclusion

This script simplifies the deployment process for developers by abstracting the complexities of Kubernetes. By providing the necessary configuration in the config.yaml file, developers can quickly deploy their applications to a Kubernetes cluster with ease.

Enjoy deploying your applications without the need for in-depth Kubernetes knowledge!