From 3a3ffcf3a4a87e2ab11e7917f71d228e731c4aac Mon Sep 17 00:00:00 2001 From: Bart Vanbrabant Date: Wed, 17 Apr 2019 15:15:11 +0200 Subject: [PATCH 1/3] First update --- docs/architecture.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/architecture.rst b/docs/architecture.rst index 3f9c87208b..c04973321a 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,3 +1,5 @@ +.. _arch: + Architecture ============ @@ -60,6 +62,20 @@ In a push to server model, the server is deployed on an external machine, but mo machine. This gives faster feedback to developers, but makes the compilation less reproducible. It also complicates collaboration. +Both the developer machine and the server need to have Inmanta installed. To compile and export models to the server from the +developer machine a `.inmanta` file is required to connect the compiler with the server. + +Create a `.inmanta` file in the project directory and include the following configuration:: + + [config] + environment=$ENV_ID + + [compiler_rest_transport] + host=$SERVER_ADDRESS + port=$SERVER_PORT + +Replace $ENV_ID, $SERVER_ADDRESS and $SERVER_PORT with the correct values. + Autonomous server ***************** From d1a3b35e74c2a01847970746c83dc22fd18d8e8e Mon Sep 17 00:00:00 2001 From: Bart Vanbrabant Date: Wed, 17 Apr 2019 15:44:07 +0200 Subject: [PATCH 2/3] Add push to server docs --- docs/architecture.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/architecture.rst b/docs/architecture.rst index c04973321a..30637a0543 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -63,7 +63,8 @@ machine. This gives faster feedback to developers, but makes the compilation les collaboration. Both the developer machine and the server need to have Inmanta installed. To compile and export models to the server from the -developer machine a `.inmanta` file is required to connect the compiler with the server. +developer machine a `.inmanta` file is required in the project directory (where you find the main.cf and the project.yaml file) +to connect the compiler with the server. Create a `.inmanta` file in the project directory and include the following configuration:: @@ -74,7 +75,13 @@ Create a `.inmanta` file in the project directory and include the following conf host=$SERVER_ADDRESS port=$SERVER_PORT -Replace $ENV_ID, $SERVER_ADDRESS and $SERVER_PORT with the correct values. +Replace ``$ENV_ID``, ``$SERVER_ADDRESS`` and ``$SERVER_PORT`` with the correct values (See :inmanta.config:group:`compiler_rest_transport` +for more details when using ssl and or auth, :inmanta.config:option:`config.environment` explains the environment setting). A best +practice is to not add the .inmanta to the git repository. Because different developer may use different orchestration servers. + + * ``inmanta compile`` compiles the current project but does not upload the result to the orchestration server. + * ``inmanta export`` compiles and uploads the current project to the orchestration server. Depending on the environment settings the server will release and deploy the model or it becomes available in the `new` state. + * ``inmanta export -d`` compiles, uploads and releases the current project. The result will start deploying immediately. Autonomous server From b5f76e8e172c10939852145808fa143fb030a2a8 Mon Sep 17 00:00:00 2001 From: Bart Vanbrabant Date: Wed, 17 Apr 2019 15:49:50 +0200 Subject: [PATCH 3/3] Add changelog entry --- CHANGELOG.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 98eba066cf..afe7c19915 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,13 @@ v 2019.2 Changes in this release: -- various bugfixes (#1046, #968) +- Various bugfixes (#1046, #968) - Migration from mongodb to postgres - added metering using pyformance -- added influxdb reporter for protocol endpoint metrics +- Added influxdb reporter for protocol endpoint metrics - Remove the configuration option agent-run-at-start (#1055) - Add project id and environment id as optional parameters to API call (#1001) - Fixed an issue which cleared the environment on remote python 2 interpreters +- Documentation updates and improvements (#905) v 2019.1 (2019-03-06) Changes in this release: