Skip to content

Commit

Permalink
deploy: d1fdaa7
Browse files Browse the repository at this point in the history
  • Loading branch information
matheushent committed Jul 19, 2024
1 parent e1f0af6 commit 63dc0ad
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 51 deletions.
24 changes: 11 additions & 13 deletions developer_guide/dev_tools/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1228,24 +1228,22 @@ <h2 id="the-show-env-subcommand">The <code>show-env</code> subcommand</h2>
</span><span id="__span-11-15"><a id="__codelineno-11-15" name="__codelineno-11-15" href="#__codelineno-11-15"></a> S3_ENDPOINT_URL: None
</span><span id="__span-11-16"><a id="__codelineno-11-16" name="__codelineno-11-16" href="#__codelineno-11-16"></a> ARMASEC_DOMAIN: localhost:9080/realms/master/protocol/openid-connect
</span><span id="__span-11-17"><a id="__codelineno-11-17" name="__codelineno-11-17" href="#__codelineno-11-17"></a> ARMASEC_USE_HTTPS: True
</span><span id="__span-11-18"><a id="__codelineno-11-18" name="__codelineno-11-18" href="#__codelineno-11-18"></a> ARMASEC_AUDIENCE: https://local.omnivector.solutions
</span><span id="__span-11-19"><a id="__codelineno-11-19" name="__codelineno-11-19" href="#__codelineno-11-19"></a> ARMASEC_DEBUG: True
</span><span id="__span-11-20"><a id="__codelineno-11-20" name="__codelineno-11-20" href="#__codelineno-11-20"></a> ARMASEC_ADMIN_DOMAIN: None
</span><span id="__span-11-21"><a id="__codelineno-11-21" name="__codelineno-11-21" href="#__codelineno-11-21"></a> ARMASEC_ADMIN_AUDIENCE: None
</span><span id="__span-11-22"><a id="__codelineno-11-22" name="__codelineno-11-22" href="#__codelineno-11-22"></a> ARMASEC_ADMIN_MATCH_KEY: None
</span><span id="__span-11-23"><a id="__codelineno-11-23" name="__codelineno-11-23" href="#__codelineno-11-23"></a> ARMASEC_ADMIN_MATCH_VALUE: None
</span><span id="__span-11-24"><a id="__codelineno-11-24" name="__codelineno-11-24" href="#__codelineno-11-24"></a> IDENTITY_CLAIMS_KEY: https://omnivector.solutions
</span><span id="__span-11-25"><a id="__codelineno-11-25" name="__codelineno-11-25" href="#__codelineno-11-25"></a> SENTRY_DSN: None
</span><span id="__span-11-26"><a id="__codelineno-11-26" name="__codelineno-11-26" href="#__codelineno-11-26"></a> SENTRY_SAMPLE_RATE: 1.0
</span><span id="__span-11-27"><a id="__codelineno-11-27" name="__codelineno-11-27" href="#__codelineno-11-27"></a> MAX_UPLOAD_FILE_SIZE: 104857600
</span><span id="__span-11-28"><a id="__codelineno-11-28" name="__codelineno-11-28" href="#__codelineno-11-28"></a> SENDGRID_FROM_EMAIL: None
</span><span id="__span-11-29"><a id="__codelineno-11-29" name="__codelineno-11-29" href="#__codelineno-11-29"></a> SENDGRID_API_KEY: None
</span><span id="__span-11-18"><a id="__codelineno-11-18" name="__codelineno-11-18" href="#__codelineno-11-18"></a> ARMASEC_DEBUG: True
</span><span id="__span-11-19"><a id="__codelineno-11-19" name="__codelineno-11-19" href="#__codelineno-11-19"></a> ARMASEC_ADMIN_DOMAIN: None
</span><span id="__span-11-20"><a id="__codelineno-11-20" name="__codelineno-11-20" href="#__codelineno-11-20"></a> ARMASEC_ADMIN_MATCH_KEY: None
</span><span id="__span-11-21"><a id="__codelineno-11-21" name="__codelineno-11-21" href="#__codelineno-11-21"></a> ARMASEC_ADMIN_MATCH_VALUE: None
</span><span id="__span-11-22"><a id="__codelineno-11-22" name="__codelineno-11-22" href="#__codelineno-11-22"></a> IDENTITY_CLAIMS_KEY: https://omnivector.solutions
</span><span id="__span-11-23"><a id="__codelineno-11-23" name="__codelineno-11-23" href="#__codelineno-11-23"></a> SENTRY_DSN: None
</span><span id="__span-11-24"><a id="__codelineno-11-24" name="__codelineno-11-24" href="#__codelineno-11-24"></a> SENTRY_SAMPLE_RATE: 1.0
</span><span id="__span-11-25"><a id="__codelineno-11-25" name="__codelineno-11-25" href="#__codelineno-11-25"></a> MAX_UPLOAD_FILE_SIZE: 104857600
</span><span id="__span-11-26"><a id="__codelineno-11-26" name="__codelineno-11-26" href="#__codelineno-11-26"></a> SENDGRID_FROM_EMAIL: None
</span><span id="__span-11-27"><a id="__codelineno-11-27" name="__codelineno-11-27" href="#__codelineno-11-27"></a> SENDGRID_API_KEY: None
</span></code></pre></div>
<p>The command can also produce the output as JSON if needed by passing the <code>--json</code> flag:</p>
<div class="language-shell highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>poetry<span class="w"> </span>run<span class="w"> </span>dev-tools<span class="w"> </span>show-env<span class="w"> </span>--json
</span></code></pre></div>
<p>The JSON output will look something like:</p>
<div class="language-json highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="p">{</span><span class="nt">&quot;DEPLOY_ENV&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;LOCAL&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;LOG_LEVEL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;DEBUG&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_HOST&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_USER&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;compose-db-user&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_PSWD&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;compose-db-pswd&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_NAME&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;compose-db-name&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_PORT&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5432</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_HOST&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_USER&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;test-user&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_PSWD&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;test-pswd&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_NAME&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;test-db&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_PORT&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5433</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;S3_BUCKET_NAME&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;jobbergate-k8s-staging&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;S3_ENDPOINT_URL&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_DOMAIN&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;localhost:9080/realms/master/protocol/openid-connect&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_USE_HTTPS&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_AUDIENCE&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://local.omnivector.solutions&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_DEBUG&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_ADMIN_DOMAIN&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_ADMIN_AUDIENCE&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_ADMIN_MATCH_KEY&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_ADMIN_MATCH_VALUE&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;IDENTITY_CLAIMS_KEY&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://omnivector.solutions&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENTRY_DSN&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENTRY_SAMPLE_RATE&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">1.0</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;MAX_UPLOAD_FILE_SIZE&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">104857600</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENDGRID_FROM_EMAIL&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENDGRID_API_KEY&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">}</span>
<div class="language-json highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="p">{</span><span class="nt">&quot;DEPLOY_ENV&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;LOCAL&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;LOG_LEVEL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;DEBUG&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_HOST&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_USER&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;compose-db-user&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_PSWD&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;compose-db-pswd&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_NAME&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;compose-db-name&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;DATABASE_PORT&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5432</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_HOST&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_USER&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;test-user&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_PSWD&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;test-pswd&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_NAME&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;test-db&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;TEST_DATABASE_PORT&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5433</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;S3_BUCKET_NAME&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;jobbergate-k8s-staging&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;S3_ENDPOINT_URL&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_DOMAIN&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;localhost:9080/realms/master/protocol/openid-connect&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_USE_HTTPS&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_DEBUG&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_ADMIN_DOMAIN&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_ADMIN_MATCH_KEY&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;ARMASEC_ADMIN_MATCH_VALUE&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;IDENTITY_CLAIMS_KEY&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://omnivector.solutions&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENTRY_DSN&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENTRY_SAMPLE_RATE&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">1.0</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;MAX_UPLOAD_FILE_SIZE&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">104857600</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENDGRID_FROM_EMAIL&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;SENDGRID_API_KEY&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">}</span>
</span></code></pre></div>
<h2 id="the-dev-server-subcommand">The <code>dev-server</code> subcommand</h2>
<p>This command starts up a local development server for the Jobbergate API. It will
Expand Down
38 changes: 1 addition & 37 deletions developer_guide/keycloak_setup/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -832,13 +832,6 @@
<nav class="md-nav" aria-label="Add Mappers">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#audience" class="md-nav__link">
Audience
</a>

</li>

<li class="md-nav__item">
<a href="#permissions" class="md-nav__link">
Permissions
Expand Down Expand Up @@ -879,13 +872,6 @@
<nav class="md-nav" aria-label="Add Mappers">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#audience_1" class="md-nav__link">
Audience
</a>

</li>

<li class="md-nav__item">
<a href="#permissions_1" class="md-nav__link">
Permissions
Expand Down Expand Up @@ -1154,13 +1140,6 @@
<nav class="md-nav" aria-label="Add Mappers">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#audience" class="md-nav__link">
Audience
</a>

</li>

<li class="md-nav__item">
<a href="#permissions" class="md-nav__link">
Permissions
Expand Down Expand Up @@ -1201,13 +1180,6 @@
<nav class="md-nav" aria-label="Add Mappers">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#audience_1" class="md-nav__link">
Audience
</a>

</li>

<li class="md-nav__item">
<a href="#permissions_1" class="md-nav__link">
Permissions
Expand Down Expand Up @@ -1343,10 +1315,6 @@ <h3 id="add-roles">Add Roles</h3>
<h3 id="add-mappers">Add Mappers</h3>
<p>Jobbergate requires two claims that are not available by default. We will add them to the JWTs with Mappers.</p>
<p>Click the <code>Mappers</code> tab at the top, and then click the <code>Create</code> button to add a new Mapper.</p>
<h4 id="audience">Audience</h4>
<p>First, we need to add an "audience" mapper. Select "audience" for the <code>Name</code> field. Next, select "Audience" for the
<code>Mapper Type</code>. The <code>Included Custom Audience</code> value may be whatever you like. The local deploy, by default, uses
<a href="https://apis.omnivector.solutions">https://apis.omnivector.solutions</a>. Make sure to enable the <code>Add to ID token</code> setting.</p>
<h4 id="permissions">Permissions</h4>
<p>The <code>Armasec</code> package expects to find "permissions" in a claim at the root
of the JWT payload. To facilitate this, we need to add a mapper that will copy the permissions to the correct place in
Expand Down Expand Up @@ -1399,12 +1367,8 @@ <h3 id="add-roles_1">Add Roles</h3>
</tbody>
</table>
<h3 id="add-mappers_1">Add Mappers</h3>
<p>Like the CLI client, the Agent's client also requires the "Audience" and "Permissions" mappers.</p>
<p>Like the CLI client, the Agent's client also requires the "Permissions" mapper.</p>
<p>Click the <code>Mappers</code> tab at the top, and then click the <code>Create</code> button to add a new Mapper.</p>
<h4 id="audience_1">Audience</h4>
<p>First, we need to add an "audience" mapper. Select "audience" for the <code>Name</code> field. Next, select "Audience" for the
<code>Mapper Type</code>. The <code>Included Custom Audience</code> value may be whatever you like. The local deploy, by default, uses
"<a href="https://apis.omnivector.solutions">https://apis.omnivector.solutions</a>". Make sure to enable the <code>Add to ID token</code> setting.</p>
<h4 id="permissions_1">Permissions</h4>
<p>Next, add a "permissions" mapper. The <code>Armasec</code> package expects to find a "permissions" claims under a claim at the root
of the JWT payload. Enter "Permissions" under the <code>Name</code> field. Next, select "User Client Role" as the <code>Mapper Type</code>.
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit 63dc0ad

Please sign in to comment.