当前系统网源管理

Prerequisites

• PHP ^8.5
• Laravel ^13.0

GCP Instance Requirements

Instances must: - Be named with the pattern matching INSTANCE_GROUP_NAME (e.g., development-api-01) - Be in RUNNING state - Have SSH access configured with the provided private key - Have Docker and Docker Compose installed - Have the application directory structure in place

Initial Setup

1. Use the `docker compose up --build -d` to bring up the containers. Make sure to have Docker Desktop active and have no other containers running that may cause conflict with this project's containers(There may be conflicts port wise if more than one container uses the same ports).

1. Check the status of containers using the command

    ps

   . Make sure they are running and services are healthy.

1. Get inside the database container using

    exec -it mysqlLaravel /bin/bash

   . Then, create 7 databases: inventory, social, crm, workflow, commerce, action_engine, event.

1. Set up your .env: You can start by copying the .env.example setup. Next, update it with the database and Redis connection info, making sure that the host values match your container's name.

1. Get inside the php container using

    exec -it phpLaravel bash

   .

6. Generate app keys with php artisan key:generate. Note: Confirm that your app key is correctly registered in the apps table within the kanvas_laravel database.

7. Update the app variables in your .env APP_JWT_TOKEN, APP_KEY, KANVAS_APP_ID before running the setup-ecosystem. Note: You can use the default values provided in tests.yml.

1. Use the command

    artisan kanvas:setup-ecosystem

   to run the kanvas setup.

1. If you're presenting some errors after running the command from before, drop all the tables from the schema kanvas_laravel and run it again.

1. To check if the API is working just make a GET request to

   ://localhost:80/v1/

   and see if the response returns

   "Woot Kanvas"

   .

Setup Inventory

1. composer migrate-inventory 2. Set env var in .env

DB_INVENTORY_HOST=mysqlLaravel
DB_INVENTORY_PORT=3306
DB_INVENTORY_DATABASE=inventory
DB_INVENTORY_USERNAME=root
DB_INVENTORY_PASSWORD=password

php artisan inventory:setup to create and initialize the inventory module for a current company

Setup Social

1. composer migrate-social 2. Set env var in .env

DB_SOCIAL_HOST=mysqlLaravel
DB_SOCIAL_PORT=3306
DB_SOCIAL_DATABASE=social
DB_SOCIAL_USERNAME=root
DB_SOCIAL_PASSWORD=password

php artisan social:setup to create and initialize the social module for a current company

Setup Guild

1. composer migrate-crm 2. Set env var in .env

DB_CRM_HOST=mysqlLaravel
DB_CRM_PORT=3306
DB_CRM_DATABASE=cr
DB_CRM_USERNAME=root
DB_CRM_PASSWORD=password

php artisan guild:setup to create and initialize the crm module for a current company

Deployment to GCP with Ansible

This project uses GitHub Actions with Ansible to deploy to Google Cloud Platform (GCP) compute instances using Workload Identity Federation for secure authentication.

GCP Setup

1. Create Workload Identity Pool

```bash export PROJECT_ID="your-project-id" export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)") export REPO="bakaphp/kanvas-ecosystem-api"

Deployment Workflow

The deployment is triggered manually via workflow_dispatch. To deploy:

1. Go to Actions tab in GitHub
2. Select "Ansible GCP Compute Deploy" workflow
3. Click "Run workflow"
4. Select the branch to deploy
5. Click "Run workflow"

What Happens During Deployment

1. Authentication: Authenticates to GCP using Workload Identity Federation
2. Dynamic Inventory: Discovers running GCP instances in the specified region matching the instance group name
3. File Sync: Syncs application files to remote servers (excluding git, node_modules, vendor, etc.)
4. Dependencies: Installs Composer dependencies
5. Migrations (optional): Runs database migrations
6. Cache: Clears and rebuilds Laravel config/route/view cache
7. Docker: Restarts Docker containers with updated code

GitHub Configuration

Required Secrets

Go to: Repository Settings → Secrets and variables → Actions → New repository secret

Required Variables

Go to: Repository Settings → Secrets and variables → Actions → Variables

GitHub Environments

Create environments matching your branch names (e.g., development, staging, main) in: Repository Settings → Environments

This allows branch-specific configurations and deployment protection rules.

Troubleshooting

Authentication Errors

Error: invalid_target

Solution: Verify the Workload Identity Provider path and ensure pool/provider are ACTIVE:

gcloud iam workload-identity-pools describe github-pool \
  --location=global \
  --project=YOUR_PROJECT_ID \
  --format="value(state)"

gcloud iam workload-identity-pools providers describe github-provider \
  --workload-identity-pool=github-pool \
  --location=global \
  --project=YOUR_PROJECT_ID \
  --format="value(state)"

Both should return ACTIVE.

No Hosts Found

Solution: Check that: - Instances are running - Instance names contain the INSTANCE_GROUP_NAME value - Instances are in the specified GCP_REGION

gcloud compute instances list \
  --project=YOUR_PROJECT_ID \
  --filter="name~INSTANCE_GROUP_NAME AND status=RUNNING"

SSH Connection Issues

Solution: Verify SSH key is correct and user has access:

```bash