compagnyhelper

Compagny helper

Tired to find into your bookmarks a corporate link?

Why do not use a helper command line in order to retrieve for example the compagny kibana urls?

How its work

A client cli will contact a server containing all the corporate usefull links

Client configuration

How to install

You may also download the appropriate release for your platform from the releases page.

You need to register the URL of the server, you can configure it in $HOME/.compagnyhelper.yaml

url_server: "http://localhost:8080"

Note: For mac user, as the binary is not signed and notorized you have to authorize it in "Security & Privacy" control panel.

Client Example

Get All application registered:

compagnyhelper get link

Get All application registered in dedicated namespace:

compagnyhelper get link --n dev

Get link of an application:

compagnyhelper get link Kibana --n dev

Describe an application link

compagnyhelper describe link Kibana --n dev

Open application in a borwser

compagnyhelper open link Kibana --n prod

Server launch

Launch the server with following command

compagnyhelper server

Check additional option with -help command

json application sample

{
    "applications": [
        {
            "shortname": "Kibana",
            "appdesc": {
                "longname": "Kibana Dashboard for yourr logs",
                "link": "http://kibana.com",
                "env": "dev"
            }
        },
        {
            "shortname": "Grafana",
            "appdesc": {
                "longname": "Grafana Dashboard for yourr metrics",
                "link": "http://grafana.com",
                "env": "dev"
            }
        },
        {
            "shortname": "Kibana",
            "appdesc": {
                "longname": "Kibana Dashboard for yourr logs",
                "link": "http://kibana.com",
                "env": "prod"
            }
        }
    ]
}

Deployment on Kubernetes

1. Create the configmap

   kubectl create configmap compagnyhelper-cm --from-file=apps.json --dry-run -o yaml > deployment/configmap.yml
   

2. Apply the deployment

   kubectl apply -f deployment
   

3. Create en external service with LB, or ingress, or gateway in order to publish your endpoint