Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
L
libvmod-all_healthy
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
uplex-varnish
libvmod-all_healthy
Commits
c4e698e9
Commit
c4e698e9
authored
Aug 10, 2018
by
Nils Goroll
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
add the generated rst as README for now
parent
dadffe06
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
167 additions
and
0 deletions
+167
-0
README.rst
README.rst
+167
-0
No files found.
README.rst
0 → 100644
View file @
c4e698e9
..
.. NB: This file is machine generated, DO NOT EDIT!
..
.. Edit vmod.vcc and run make instead
..
.. role:: ref(emphasis)
.. _vmod_all_healthy(3):
================
vmod_all_healthy
================
--------------------------
Varnish all_healthy Module
--------------------------
:Manual section: 3
SYNOPSIS
========
::
import all_healthy [from "path"] ;
new xdirector = director()
VOID xdirector.consider(BACKEND)
VOID xdirector.set_backend(BACKEND)
BACKEND xdirector.backend()
DESCRIPTION
===========
The all_healthy vmod provides a varnish director tieing the health
state of several other backends / health states: An all_healthy
director is only healthy if all backends to consider are healthy. It
always resolves to exactly one backend, which may or may not be part
of the set of backends considered for health state.
An all_healthy director will commonly be layered below other directors
for actual load balancing.
Examples and use cases:
* Using more than one health checks for a backend::
probe probe_a { ... }
probe probe_b { ... }
backend be_a {
.host = "1.2.3.4";
.probe = probe_a;
}
# will never actually be used, only provides the second probe
backend be_b {
.host = "1.2.3.4";
.probe = probe_b;
}
sub vcl_init {
new be = all_healthy.director();
# implies be.set_backend(be_a);
be.consider(be_a);
be.consider(be_b);
some_director.add_backend(be);
}
sub vcl_backend_fetch {
set bereq.backend = be.backend();
}
* Checking health on a different port::
probe oob_probe { ... }
backend be_traffic {
.host = "1.2.3.4";
# no .probe !
}
backend be_oob_probe {
.host = "1.2.3.4";
.port = "4242";
.probe = oob_probe;
}
sub vcl_init {
new be = all_healthy.director();
be.consider(be_oob_probe);
be.set_backend(be_traffic);
some_director.add_backend(be);
}
sub vcl_backend_fetch {
set bereq.backend = be.backend();
}
CONTENTS
========
* :ref:`obj_director`
* :ref:`func_director.backend`
* :ref:`func_director.consider`
* :ref:`func_director.set_backend`
.. _obj_director:
new xdirector = director()
--------------------------
Instantiate an all_healthy director.
.. _func_director.consider:
VOID xdirector.consider(BACKEND)
--------------------------------
Add a backend to consider for determining the health state of the
director.
This method may only be called from vcl_init {}
.. _func_director.set_backend:
VOID xdirector.set_backend(BACKEND)
-----------------------------------
Set the backend the director resolves to.
This method may only be called from vcl_init {}
.. _func_director.backend:
BACKEND xdirector.backend()
---------------------------
Return the all_healthy director instance, which will resolve to the
backend set using the .set_backend() method.
SEE ALSO
========vcl\(7),varnishd\(1)
COPYRIGHT
=========
::
This document is copyright and licensed under the same conditions as
the libvmod-all_healthy project. See LICENSE for details.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment