mirror of https://github.com/sablierapp/sablier.git synced 2025-12-24 22:39:25 +01:00

Files

Alexis Couvreur be7ace0e05 perf(providers): retrieve state on start instead of assuming starting (#350 )

When an instance does not exist yet and needs to be started, its status is not assumed to be starting anymore.

Instead, the statue will be retrieved from the provider. This changes one thing, it's that you may be able to start and access your services instantly because they'll be instantly seen as ready.

With this change, you might want to make sure that your containers have a proper healthcheck used to determine when the application is able to process incoming requests.

* refactor: add interface guards

* refactor(providers): remove instance.State as a return value from Stop and Start

* test(e2e): add healthcheck on nginx container

Because now the container check is so fast, we need to add a delay on which the container is considered started and healthy to have a proper waiting page.

* fix(tests): using acouvreur/whoami:v1.10.2 instead of containous/whoami:v1.5.0

This image simply retrieve the curl binary from curlimages/curl:8.8.0 to be able to add proper docker healthcheck commands.

Once this is merged with traefik/whoami, I'll update back to the original image.

See https://github.com/traefik/whoami/issues/33

2024-07-08 00:10:39 -04:00

e2e

perf(providers): retrieve state on start instead of assuming starting (#350 )

2024-07-08 00:10:39 -04:00

njs

fix(nginx): blocking strategy correctly supports groups

2024-02-05 13:20:08 -05:00

README.md

feat: add filter by labels (#134 )

2023-03-28 21:31:22 -04:00

README.md

Nginx NJS Sablier Module

Kubernetes is not supported yet

Configuration

Load the ngx_http_js_module.so in the main nginx config file /etc/nginx/nginx.conf
```
load_module modules/ngx_http_js_module.so;
```
Copy/volume the sablier.js file to /etc/nginx/conf.d/sablier.js

Use this sample for your APIs

js_import conf.d/sablier.js;

resolver 127.0.0.11 valid=10s ipv6=off;

server {
listen 80;

    subrequest_output_buffer_size 32k;

    # The internal location to reach sablier API
    set $sablierUrl /sablier;
    # Shared variable for default session duration
    set $sablierSessionDuration 1m;

    # internal location for sablier middleware
    # here, the sablier API is a container named "sablier" inside the same network as nginx
    location /sablier/ {
        internal;
        proxy_method GET;
        proxy_pass http://sablier:10000/;
    }

    # A named location that can be used by the sablier middleware to redirect
    location @whoami {
        # Here is your container name, same in 
        #             set $sablierNames whoami;
        # Use variable in order to refresh DNS cache
        set $whoami_server whoami;
        proxy_pass http://$whoami_server:80;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }

    # The actual location to match your API
    # Will answer by a waiting page or redirect to your app if
    # it is already up
    location /dynamic/whoami {
        set $sablierDynamicShowDetails true;
        set $sablierDynamicRefreshFrequency 5s;
        set $sablierNginxInternalRedirect @whoami;
        # Here is your container name
        set $sablierNames whoami;
        set $sablierDynamicName "Dynamic Whoami";
        set $sablierDynamicTheme hacker-terminal;
        js_content sablier.call;
    }
}

Available variables

You can configure the middleware behavior with the following variables:

General Configuration

set $sablierUrl The internal routing to reach Sablier API
set $sablierNames Comma separated names of containers/services/deployments etc.
set $sablierGroup Group name to use to filter by label, ignored if sablierNames is set
set $sablierSessionDuration The session duration after which containers/services/deployments instances are shutdown
set $sablierNginxInternalRedirect The internal location for the service to redirect e.g. @nginx

Dynamic Configuration

if any of these variables is set, then all Blocking Configuration is ignored

set $sablierDynamicName
set $sablierDynamicShowDetails Set to true or false to show details specifcally for this middleware, unset to use Sablier server defaults
set $sablierDynamicTheme The theme to use
set $sablierDynamicRefreshFrequency The loading page refresh frequency

Blocking Configuration

set $sablierBlockingTimeout waits until services are up and running but will not wait more than timeout

Development

Change the njs/sablier.js configuration and start the tests for the given provider e2e/<provider>.sh (docker, kubernetes, etc.)