{{ values.description }}

This is a {{ values.appType }} built with {{ values.appLanguage }}, created using the Backstage GitHub Repository Generator template.

• Application Type: {{ values.appType }}

• Runtime: {{ values.appLanguage }}

• Port: {{ values.port }}

• Containerized: Docker support included

• Kubernetes Ready: Helm charts included

• Auto-scaling: Horizontal Pod Autoscaler configured ({{ values.minReplicas }}-{{ values.maxReplicas }} replicas)

• Health Checks: Liveness and readiness probes configured

• Python 3.11+

• pip

• Docker (for containerization)

• Kubernetes cluster (for deployment)

• Helm 3+ (for chart deployment)

1. Clone the repository:

   git clone https://github.com/{{ values.repoOwner }}/{{ values.repoName }}.git
   cd {{ values.repoName }}

2. Install dependencies:

   pip install -r requirements.txt

3. Start the application:

   python app.py

The application will be available at http://localhost:{{ values.port }}

• Health: GET /health - Application health status
• Readiness: GET /ready - Application readiness status

docker build -t {{ values.repoOwner }}/{{ values.repoName }}:latest .

docker run -p {{ values.port }}:{{ values.port }} {{ values.repoOwner }}/{{ values.repoName }}:latest

1. Install the Helm chart:

   helm install {{ values.repoName }} ./infrastructure/helm

2. Upgrade the deployment:

   helm upgrade {{ values.repoName }} ./infrastructure/helm

3. Uninstall:

   helm uninstall {{ values.repoName }}

The Helm chart supports the following key configurations:

• Replicas: {{ values.replicas }} (initial)

• Auto-scaling: {{ values.minReplicas }}-{{ values.maxReplicas }} replicas

• CPU Threshold: {{ values.cpuThreshold }}%

• Memory Threshold: {{ values.memoryThreshold }}%

• Resources:

  • CPU: {{ values.cpuRequest }} (request), {{ values.cpuLimit }} (limit)
  • Memory: {{ values.memoryRequest }} (request), {{ values.memoryLimit }} (limit)

• Service Type: {{ values.serviceType }}

Edit infrastructure/helm/values.yaml to customize the deployment according to your needs.

{{ values.repoName }}/
├── README.md
├── catalog-info.yaml          # Backstage catalog definition

├── Dockerfile                 # Container definition


└── infrastructure/
    └── helm/                  # Helm chart
        ├── Chart.yaml
        ├── values.yaml
        └── templates/
            ├── deployment.yaml
            ├── service.yaml

            ├── hpa.yaml       # Horizontal Pod Autoscaler


            └── ...

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

This project is licensed under the MIT License - see the LICENSE file for details.

For questions or support, please contact the platform team or create an issue in this repository.