https://github.com/bygui86/go-k8s-probes

Flexible solution to fastly implement Kubernetes probes in Golang
https://github.com/bygui86/go-k8s-probes

Last synced: 2 days ago
JSON representation

Flexible solution to fastly implement Kubernetes probes in Golang

• Host: GitHub
• URL: https://github.com/bygui86/go-k8s-probes
• Owner: bygui86
• License: apache-2.0
• Created: 2021-01-02T15:23:22.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-20T15:40:22.000Z (almost 4 years ago)
• Last Synced: 2024-11-08T06:07:49.720Z (about 2 months ago)
• Language: Go
• Size: 7.04 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# go-k8s-probes

Flexible solution to fastly implement Kubernetes probes in Golang

## Prerequisites

- PostgreSQL

## Run

1. Start PostgreSQL

    ```bash

    make start-postgres

    ```

1. Start application

    ```bash

    make run

    ```

## Endpoints

### Application

Root URL: `localhost:8080`

| Method | URL | Description |

| --- | --- | --- |

| GET | /api/v1/products | Fetch list of products |

| GET | /api/v1/products/{id} | Fetch a product by ID |

| POST | /api/v1/products | Create a new product |

| PUT | /api/v1/products/{id} | Update an existing product retrieved by ID |

| DELETE | /api/v1/products/{id} | Delete a product by ID |

### Prometheus metrics

Root URL: `localhost:9090`

| Method | URL | Description |

| --- | --- | --- |

| GET | /metrics | Fetch Prometheus metrics |

### Kubernetes probes

Root URL: `localhost:9091`

| Method | URL | Description |

| --- | --- | --- |

| GET | /live | Fetch liveness info |

| GET | /ready | Fetch readiness info |