acs-container-procs.tcl

Publicity: Public Only All

acs-container-procs.tcl

This file defines the following Objects and Classes: ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container, ::acs::Container

Location:

packages/acs-tcl/tcl/acs-container-procs.tcl

Procedures in this file

Class ::acs::Container (public)
acs::Container instproc active_p (public)
acs::Container instproc init (protected)
acs::Container instproc mapping (public)

Detailed information

Class ::acs::Container (public)

 ::nx::Class ::acs::Container

This class captures the information whether or not OpenACS is running inside a container. This is important since the container provide container-internal and external IP addresses. The internal IP addresses are e.g. needed when running a regression test inside a container, while the external address is needed for e.g. redirects. In the case of Docker, the networking information can be collected in a container setup script with the following command. curl -s --unix-socket /var/run/docker.sock # -o /scripts/docker.config # http://localhost/containers/${HOSTNAME}/json The docker API/pipe requires ROOT permissions for accessing the socket (or the full docker setup with the "docker" user). To keep the docker container small, we follow the approach with the root privilege, but this has to be done in a setup script before NaviServer switches to the non-privileged user. A sample setup script will be made available together with the openacs docker container. In general, one can extend this class to handle as well other container mechanisms via subclassing and determining the kind of container during startup. So far, there is only Docker support. Create the container object e.g. as ::acs::Container create acs::container

Testcases:
No testcase defined.

acs::Container method active_p (public)

 <instance of acs::Container> active_p

Check, if we are running inside a Docker container

Testcases:
No testcase defined.

acs::Container method init (protected)

 <instance of acs::Container> init

In case, a docker mapping is provided, source it to make it accessible during configuration. The mapping file is a Tcl script providing at least the Tcl dict ::docker::containerMapping containing the docker mapping. A dict key like "8080/tcp" (internal port) will return a dict containing the keys "host", "port" and "proto" (e.g. proto https host 192.168.1.192 port 58115).

Testcases:
No testcase defined.

acs::Container method mapping (public)

 <instance of acs::Container> mapping

Return the container mapping

Testcases:
No testcase defined.

[ show source ]