Skip to content

Issue/905 docs #1108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bartv merged 4 commits into from
Apr 17, 2019
Merged

Issue/905 docs #1108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a3ffcf
First update
bartv Apr 17, 2019
d1a3b35
Add push to server docs
bartv Apr 17, 2019
b5f76e8
Add changelog entry
bartv Apr 17, 2019
4721576
Merge branch 'master' into issue/905-docs
bartv Apr 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
v 2019.2
Changes in this release:
- various bugfixes (#1046, #968, #1045)
- Various bugfixes (#1046, #968, #1045)
- 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:
Expand Down
23 changes: 23 additions & 0 deletions docs/architecture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _arch:

Architecture
============

Expand Down Expand Up @@ -60,6 +62,27 @@ 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 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::

[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 (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
*****************
Expand Down