Package Health Score

55 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Popularity

Small

GitHub Stars: 1.04K
Forks: 275
Contributors: 70

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package kmm4g, we found that it has been starred 1,036 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 15, 2022
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like kmm4g is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 181
Open PR: 16
Last Release: 2 years ago
Last Commit: 3 months ago

Further analysis of the maintenance status of kmm4g based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for kmm4g is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 70
Funding: Yes

With more than 10 contributors for the kmm4g repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like kmm4g is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 3 years
Latest Release: 2 years ago
Dependencies: N/A
Versions: 7
Maintainers: 1
Wheels: No

Readme

Kubernetes MySQL Manager for GIG based clouds.

Introduction

The KMM4G script uses the MySQL Operator Kubernetes Controller that can be installed into any existing Kubernetes cluster hosted on GIG based clouds. Once installed, it will enable users to create and manage production-ready MySQL clusters using a simple declarative configuration format.

Common operational tasks such as backing up databases and restoring from an existing backup are made extremely easy. In short, the KMM4G abstracts away the hard work of running MySQL inside Kubernetes.

This script runs on Kubernetes Clusters that are hosted on GIG based clouds which offers IaaS and S3 Cloud for private and public use cases. Check GIG based clouds to learn more about what they offer.

Pre-Installing

You need to have a Kubernetes Cluster with Container Storage Interface (CSI) which is offered by GIG based clouds.
Object storage (S3) provided by GIG based clouds to store and restore backups.
You need to have Helm Charts version 3 installed on your machine.

Installation Guide

pip install kmm4g
Run command kmm4g

Script Functions

Install MySQL-Operator
Create MySQL-Cluster
Create Cluster From Existing Backup
List Your Clusters
Edit Cluster
Remove Cluster
List Backups
Exit

Step-by-Step Guide

> If you are installing the script for the first time, you need to choose "Install MySQL-Operator" option. This command will configure and set up MySQL-Operator with the needed packages on your Kubernetes Clusters. If you have MySQL-Operator installed on your Kubernetes Clusters, then you won't be able to install it again.

`Create MySQL-Cluster`

You can select this option if you want to create a new MySQL-Cluster. Then you will need to enter your MySQL Cluster data.

Input	Value
JWT	Your JWT token provided on your GIG based clouds Account.
API URL	Your GIG based clouds API URL (e.g cloud.gig.tech/api/1)
Customer ID	Your GIG based clouds Customer_ID provided in your GIG based clouds Account and also in your Cloudspace URL.
CloudSpace ID	The ID of your GIG based cloudsspace that contains your Kubernetes Cluster, you can find it in your Cloudspace URL.
Cluster Name	The name of your MySQL Cluster (feel free to name it as you like).
Number of Replicas	Number of replicas of your MySQL Cluster.
Root Password	The root password of your MySQL Cluster.
MySQL NodePort [30000-32767]	The port to access your MySQL Cluster (please select a port between 30000-32767 and make sure that this port isn't used before).
Cluster Size (Gi)	Your MySQL Cluster size in GigaBytes.
Enable Auto Backup ? [yes/no]	Select whether you want to enable auto backup or not.
Backup Schedule [daily/weekly/monthly/yearly/custom]	If you enabled auto backup, then you will need to add a schedule for your backup whether daily, weekly, monthly, yearly or even custom.
Custom Backup Cronjob	If you selected custom schedule, then you need to set the backup cronjob. Learn more about writing custom cronjobs check MySQL Operator Repo.
Number of Backups Limit	The maximum number of backups to be saved (e.g if the limit is 5 then the latest 5 backups will be saved and the older versions will be deleted automatically).
Object Storage Endpoint	The domain of your object storage without adding http or https (e.g example.com).
Object Storage Port	The port that you will use to access your object storage.
Object Storage Access Key	The access key for your object storage, you cand find it on GIG based clouds Portal.
Object Storage Secret Key	The secret key for your object storage, you cand find it on GIG based clouds Portal.
Bucket Name	Enter your bucket name (If you entered a name of existing bucket the script will use it. However, if you entered a new name that isn't used before the script will create a bucket with the new name for you then use it).

For every finished operation you will receive a couple of confirmation messages. At the end, you'll have your MySQL Cluster configured.

Object storage connected
Bucket  has been created
Creating serverpool...
ServerPool Status 200
Add kubernetes hosts to serverpool...

Add hosts to ServerPool Status 200
Creating LoadBalancer...

Deploying your cluster with auto backup...
NAME: 
LAST DEPLOYED: 
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None

Please wait until the cluster becomes ready...
Access your cluster with port

> You can test whether your MySQL Cluster is ready or not using this command kubectl get pod | grep .

> Adittionally, to access your MySQL Cluster use this command mysql -uroot -p -h -P .

`Create Cluster From Existing Backup`

You can select this option if you want to create a new MySQL-Cluster from an existing backup. Then you will need to enter your MySQL Cluster data and the used Backup data.

Input	Value
JWT	Your JWT token provided on your GIG based clouds Account.
API URL	Your GIG based clouds API URL (e.g cloud.gig.tech/api/1)
Customer ID	Your GIG based clouds Customer_ID provided in your GIG based clouds Account and also in your Cloudspace URL.
CloudSpace ID	The ID of your GIG based cloudsspace that contains your Kubernetes Cluster, you can find it in your Cloudspace URL.
Cluster Name	The name of your MySQL Cluster (feel free to name it as you like).
Number of Replicas	Number of replicas of your MySQL Cluster.
Root Password	The root password of your MySQL Cluster. (Should be the same root password as your backup)
MySQL NodePort [30000-32767]	The port to access your MySQL Cluster (please select a port between 30000-32767 and make sure that this port isn't used before).
Cluster Size (Gi)	Your MySQL Cluster size in GigaBytes.
Object Storage Endpoint:	The domain of your object storage without adding http or https (e.g example.com).
Object Storage Port	The port that you will use to access your object storage.
Object Storage Access Key	The access key for your object storage, you cand find it on GIG based clouds Portal.
Object Storage Secret Key	The secret key for your object storage, you cand find it on GIG based clouds Portal.
Bucket Name	Enter your bucket name (If you entered a name of existing bucket the script will use it. However, if you entered a new name that isn't used before the script will create a bucket with the new name for you then use it).
Enter Your Backup Number	The script will show you the list of backups connected to you object storage endpoint you entered before, just enter the number of the desired backup to be used in this cluster.

For every finished operation you will receive a couple of confirmation messages. At the end, you'll have your MySQL Cluster configured.

You select 
Creating serverpool...
ServerPool Status 200
Add kubernetes hosts to serverpool...

Add hosts to ServerPool Status 200
Creating LoadBalancer...

Deploying your cluster...
NAME: 
LAST DEPLOYED: 
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None

Please wait until the cluster becomes ready...
Access your cluster with port

> You can test whether your MySQL Cluster is ready or not using this command kubectl get pod | grep .

> Adittionally, to access your MySQL Cluster use this command mysql -uroot -p -h -P .

`List Clusters`

You can select this option if you want to list all your MySQL Clusters with their access ports.

`Edit Cluster`

You can select this option if you want to edit MySQL Clusters, the script allows you to change the number of replicas and change the backup schedule (Changing backup schedule is allowed only for MySQL Clusters that has auto backup enabled).

`Remove Cluster`

You can select this option if you want to uninstall a MySQL Cluster. Just enter the cluster name that you want to remove and it will be uninstalled.

`List Backups`

You can select this option if you want to list all your backups.

Input	Value
Object Storage Endpoint	The domain of your object storage without adding http or https (e.g example.com).
Object Storage Port	The port that you will use to access your object storage.
Object Storage Access Key	The access key for your object storage, you cand find it on GIG based clouds Portal.
Object Storage Secret Key	The secret key for your object storage, you cand find it on GIG based clouds Portal.
Bucket Name	Enter the bucket name that contains your backups.

FAQs

What is kmm4g?

Kubernetes MySQL Manager for GIG.tech based clouds. Visit Snyk Advisor to see a full health score report for kmm4g, including popularity, security, maintenance & community analysis.

Is kmm4g popular?

The python package kmm4g receives a total of 56 weekly downloads. As such, kmm4g popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is kmm4g well maintained?

We found indications that kmm4g is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is kmm4g safe to use?

The python package kmm4g was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 2 November-2024, at 06:30 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

kmm4g

Kubernetes MySQL Manager for GIG.tech based clouds. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Kubernetes MySQL Manager for GIG based clouds.

Introduction

Pre-Installing

Installation Guide

Script Functions

Step-by-Step Guide

`Create MySQL-Cluster`

`Create Cluster From Existing Backup`

`List Clusters`

`Edit Cluster`

`Remove Cluster`

`List Backups`

FAQs

What is kmm4g?

Is kmm4g popular?

Is kmm4g well maintained?

Is kmm4g safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Kubernetes MySQL Manager for GIG based clouds.

Introduction

Pre-Installing

Installation Guide

Script Functions

Step-by-Step Guide

Create MySQL-Cluster

Create Cluster From Existing Backup

List Clusters

Edit Cluster

Remove Cluster

List Backups

FAQs

What is kmm4g?

Is kmm4g popular?

Is kmm4g well maintained?

Is kmm4g safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`Create MySQL-Cluster`

`Create Cluster From Existing Backup`

`List Clusters`

`Edit Cluster`

`Remove Cluster`

`List Backups`