goboilerplate

Getting Started

To run the application, follow these steps:

Prerequisites

• Go 1.21+ installed on your system.
• An active OpenStack account with valid credentials.
• MySQL 8.0.36+ installed on your system and accessible.

Installation

Create Database

```
mysql -h MYSQL_ADDRESS -u DATABSE_USER --password=YOUR_PASS --database=YOUR_DB < scripts/vke.sql 
```

Configuring and Running the Application Locally

1. Clone the repo

   git clone https://github.com/vmindtech/vke.git
   cd vke
   

2. Environment Configuration Create a configuration file (e.g., config-development.json or config-production.json) with the following structure:

        {
          "APP_NAME" : "vke",
          "PORT" : "80",
          "ENV" : "development",
          "VERSION" : "1.0.0",
          "MYSQL_URL": "USER:PASS@tcp(MYSQL_ADDRESS:3306)/DATABASE?charset=utf8&parseTime=true&loc=Europe%2FIstanbul",
          "COMPUTE_ENDPOINT": "https://OPENSTACK_DOMAIN:8774",
          "NETWORK_ENDPOINT": "https://OPENSTACK_DOMAIN:9696",
          "LOAD_BALANCER_ENDPOINT": "https://OPENSTACK_DOMAIN:9876",
          "IDENTITY_ENDPOINT": "https://OPENSTACK_DOMAIN:5000",
          "CLOUDFLARE_AUTH_TOKEN": "YOUR_CLOUDFLARE_TOKEN",
          "CLOUDFLARE_ZONE_ID": "YOUR_CLOUDFLARE_ZONE_ID",
          "CLOUDFLARE_DOMAIN": "YOUR_DOMAIN_FOR_DNS_RECORD",
          "PUBLIC_NETWORK_ID": "PUCLIC_NETWORK_UUID",
          "IMAGE_REF": "UBUNTU20.04-IMAGE-UUID",
          "NOVA_MICRO_VERSION": "2.88",
          "ENDPOINT":  "YOUR_VKE_API_PUBLIC_ADDRESS exp: http://vmind.com.tr/api/v1",
          "VKE_AGENT_VERSION": "1.0.0",
          "CLUSTER_AUTOSCALER_VERSION": "0.73",
          "CLOUD_PROVIDER_VKE_VERSION": "2.29.2",
          "OPENSTACK_LOADBALANCER_ADMIN_ROLE": "load-balancer_admin",
          "OPENSTACK_USER_OR_MEMBER_ROLE": "member"
        }
   

   Set the environment variable for your application's environment using the following commands in the terminal:

   export golang_env=development
   

   or

   export golang_env=production
   

   These commands will help you specify the runtime environment for your application.

3. Run the Application

   To run the application using Air for automatic reloading during development, use the following command in the terminal:

   air -c .air.toml
   

   This command will start the application and automatically reload it whenever code changes are detected, making your development process faster and more efficient.

Running the Application with Docker

To run the application with Docker, follow these steps:

1. Build the Docker image or pull it from Docker Hub:

   • To build the Docker image locally:

     docker build -t vmindtech/vke-app .
     

   • Alternatively, you can pull the ready-made image from Docker Hub:

     docker pull vmindtech/vke-application:tag
     

     Replace tag with the desired version tag, for example 1.0.

2. Run the Docker container:

   docker run -ti -v /opt/vke/config-production.json:/config-production.json -e golang_env='production' -p 8080:80 --name vke-application vmindtech/vke-application:tag
   

   Replace tag with the desired version tag, for example 1.0.

   This command mounts either the config-production.json or config-development.json file from your host machine into the container, sets the golang_env environment variable to 'production' or 'development' accordingly, and forwards requests from port 8080 on your host machine to port 80 inside the Docker container. You can replace /opt/vke/config-production.json or /opt/vke/config-development.json with the path to your actual configuration file and use any port you prefer.

3. View the application in your browser: Navigate to http://localhost:8080 in your browser to view the application.

4. Stopping and removing the container:

   docker stop vke-application
   docker rm vke-application
   

   Use the above commands to stop and remove the container when you're done.

Once you've successfully run the application with Docker, you can access it at http://localhost:8080.

License

Distributed under the APACHE-2.0 License. See LICENSE for more information.