From fce4707aab84461188cb3b35aeee08bfdeed5d05 Mon Sep 17 00:00:00 2001 From: hassan90122 Date: Tue, 28 Jul 2026 21:14:12 +0000 Subject: [PATCH] Add CI/CD pipeline documentation --- docs/environments.md | 32 +++++++++++++++++++++++++ docs/ghaymah-cli.md | 56 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 docs/environments.md create mode 100644 docs/ghaymah-cli.md diff --git a/docs/environments.md b/docs/environments.md new file mode 100644 index 0000000..82ff3ba --- /dev/null +++ b/docs/environments.md @@ -0,0 +1,32 @@ +# Staging vs Production + +## Staging Environment + +Purpose: +- Testing before release. +- Validate new features. +- Detect bugs. +- Verify Docker images. +- Run integration tests. + +Characteristics: +- Mirrors production. +- Uses test data. +- Safe for experimentation. +- Developers and QA have access. + +--- + +## Production Environment + +Purpose: +- Serve real users. +- Provide stable services. +- High availability. +- Performance optimized. + +Characteristics: +- Uses real data. +- Restricted access. +- Monitored continuously. +- Requires approval before deployment. diff --git a/docs/ghaymah-cli.md b/docs/ghaymah-cli.md new file mode 100644 index 0000000..0668215 --- /dev/null +++ b/docs/ghaymah-cli.md @@ -0,0 +1,56 @@ +# Ghaymah CLI Integration + +## Install the CLI + +```bash +curl -fsSL https://ghaymah.systems/install.sh | bash +``` + +--- + +## Login + +```bash +ghaymah login +``` + +--- + +## Verify Login + +```bash +ghaymah whoami +``` + +--- + +## Build Docker Image + +```bash +docker build -t ghaymah-sre-api . +``` + +--- + +## Push Image + +```bash +docker push registry.ghaymah.systems//ghaymah-sre-api:latest +``` + +--- + +## Deploy + +```bash +ghaymah deploy \ +--image registry.ghaymah.systems//ghaymah-sre-api:latest +``` + +--- + +## Check Deployment + +```bash +ghaymah apps list +```