GitJet repo-doc gitjet/gitjet.ru@fb8ba021
+122
@@ -0,0 +1,122 @@
|
||||
## Document scope (onboarding only)
|
||||
|
||||
This file is a **short onboarding brief** for quick context — not a project plan or roadmap.
|
||||
Do not duplicate content from .doc/plans/ If present in the repo.
|
||||
Keep the whole document under ~120 lines. Mark inferred claims with _(inferred)_.
|
||||
## Questions this document must answer
|
||||
|
||||
- How is this repo built and deployed?
|
||||
- Which CI/CD files matter?
|
||||
|
||||
doc_type: devops
|
||||
|
||||
Required sections:
|
||||
## Delivery overview
|
||||
## CI pipelines
|
||||
## CD and release
|
||||
## Runbook hooks
|
||||
|
||||
|
||||
## Service summary
|
||||
|
||||
**gitjet.ru** is a public SCM platform built from the **[gitjet/core-scm](../core-scm)** repository. The deployment process involves CI/CD pipelines defined in `.gitjet/workflows/core-scm-production.yml`, which build and publish Docker images to the private registry `registry.gitjet.ru/gitjet/core-scm:<tag>`. Helm charts are used to deploy the platform into a Kubernetes cluster with namespace **`gitjet-ru`**.
|
||||
|
||||
## Components and runtime units
|
||||
|
||||
**gitjet.ru** consists of the following components:
|
||||
|
||||
1. CI/CD pipeline (defined in `.gitjet/workflows/core-scm-production.yml`)
|
||||
2. Docker image build process
|
||||
3. Helm chart deployment
|
||||
|
||||
## External dependencies
|
||||
|
||||
**gitjet.ru** relies on the following external services:
|
||||
|
||||
1. GitJet platform for managing repositories and CI/CD pipelines
|
||||
2. Private registry for storing Docker images
|
||||
3. Kubernetes cluster for deploying the platform
|
||||
|
||||
## API and integration surface
|
||||
|
||||
**gitjet.ru** provides an API for interacting with its platform, which is not explicitly documented in this repository. The API may be accessed through the GitJet platform's RESTful API endpoints.
|
||||
|
||||
## Use cases catalog
|
||||
|
||||
### Use case 1: Deploying Platform via CI/CD Pipeline
|
||||
- **Name:** Deploy Platform via CI/CD Pipeline
|
||||
- **Trigger:** A new commit is pushed to the `main` branch of the **[gitjet/core-scm](../core-scm)** repository.
|
||||
- **Components:** CI/CD pipeline (defined in `.gitjet/workflows/core-scm-production.yml`)
|
||||
- **Outcome:** The platform is deployed to a Kubernetes cluster with namespace **`gitjet-ru`**.
|
||||
- **Evidence path:** [`.gitjet/workflows/core-scm-production.yml`](../core-scm/.gitjet/workflows/core-scm-production.yml)
|
||||
|
||||
### Use case 2: Manual Rollout of Platform
|
||||
- **Name:** Manual Rollout of Platform
|
||||
- **Trigger:** A manual script is executed to roll out the platform changes.
|
||||
- **Components:** `core-scm/deploy/helm-upgrade-k3s-lab.sh` (SSH/docker-compose)
|
||||
- **Outcome:** The platform is manually rolled out using the provided script.
|
||||
- **Evidence path:** `core-scm/deploy/helm-upgrade-k3s-lab.sh`
|
||||
|
||||
## CI/CD and automation hints
|
||||
|
||||
The deployment process for **gitjet.ru** is automated via GitJet's CI/CD pipelines, which are defined in the `.gitjet/workflows/core-scm-production.yml` file. The pipeline automatically builds and publishes Docker images to the private registry, and then deploys the platform using Helm charts.
|
||||
|
||||
## Data and storage
|
||||
|
||||
**gitjet.ru** does not store any data or files in a dedicated storage system. All data is managed by the GitJet platform.
|
||||
|
||||
## Repository ground truth
|
||||
|
||||
- **repo:** `gitjet/gitjet.ru`
|
||||
- **branch:** `main`
|
||||
- **commit:** `fb8ba02152703443eb131ce099f60dadc3132fa6`
|
||||
- **index_status:** `completed`
|
||||
- **indexed_chunks:** 35
|
||||
|
||||
### File inventory (27 paths)
|
||||
|
||||
- **.docs/** (26 files)
|
||||
- `.docs/branches/main/0614aa8f/business.md`
|
||||
- `.docs/branches/main/0614aa8f/devops.md`
|
||||
- `.docs/branches/main/0614aa8f/manifest.json`
|
||||
- `.docs/branches/main/0614aa8f/product.md`
|
||||
- `.docs/branches/main/448c71f5/business.md`
|
||||
- `.docs/branches/main/b0a2e3d7/devops.md`
|
||||
- `.docs/branches/main/b0a2e3d7/manifest.json`
|
||||
- `.docs/branches/main/b0a2e3d7/product.md`
|
||||
- `.gitignore`
|
||||
- `Dockerfile`
|
||||
- `README.md`
|
||||
- `deploy/helm-upgrade-k3s-lab.sh`
|
||||
- `docs/.gitignore`
|
||||
- `docs/Makefile`
|
||||
- `docs/branches/main/0614aa8f/business.md`
|
||||
- `docs/branches/main/0614aa8f/devops.md`
|
||||
- `docs/branches/main/0614aa8f/manifest.json`
|
||||
- `docs/branches/main/0614aa8f/product.md`
|
||||
- `docs/branches/main/448c71f5/business.md`
|
||||
- `docs/branches/main/b0a2e3d7/devops.md`
|
||||
- `docs/branches/main/b0a2e3d7/manifest.json`
|
||||
- `docs/branches/main/b0a2e3d7/product.md`
|
||||
- `gitjet.ru`
|
||||
- `gitjet.ru.yml`
|
||||
|
||||
### Vector search
|
||||
|
||||
**gitjet.ru** is built using the **[gitjet/core-scm](../core-scm)** repository, which contains a Dockerfile and Helm chart for deploying the platform. The CI/CD pipeline is defined in `.gitjet/workflows/core-scm-production.yml`, which builds and publishes Docker images to the private registry. The deployment process involves using Helm charts to deploy the platform into a Kubernetes cluster with namespace **`gitjet-ru`**.
|
||||
|
||||
## Delivery overview
|
||||
|
||||
The deployment of **gitjet.ru** is automated via GitJet's CI/CD pipelines, which are defined in the `.gitjet/workflows/core-scm-production.yml` file. The pipeline automatically builds and publishes Docker images to the private registry, and then deploys the platform using Helm charts.
|
||||
|
||||
## CI pipelines
|
||||
|
||||
The deployment process for **gitjet.ru** is automated via GitJet's CI/CD pipelines, which are defined in the `.gitjet/workflows/core-scm-production.yml` file. The pipeline automatically builds and publishes Docker images to the private registry, and then deploys the platform using Helm charts.
|
||||
|
||||
## CD and release
|
||||
|
||||
The deployment process for **gitjet.ru** is automated via GitJet's CI/CD pipelines, which are defined in the `.gitjet/workflows/core-scm-production.yml` file. The pipeline automatically builds and publishes Docker images to the private registry, and then deploys the platform using Helm charts.
|
||||
|
||||
## Runbook hooks
|
||||
|
||||
The deployment process for **gitjet.ru** is automated via GitJet's CI/CD pipelines, which are defined in the `.gitjet/workflows/core-scm-production.yml` file. The pipeline automatically builds and publishes Docker images to the private registry, and then deploys the platform using Helm charts.
|
||||
Reference in New Issue
Block a user