-
Notifications
You must be signed in to change notification settings - Fork 3
Update current release #120
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.
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
Open
EMaksy
wants to merge
6
commits into
latest
Choose a base branch
from
update_current_release
base: latest
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+447
−621
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
90c205d
add images to mcp (#119)
EMaksy c7d9b4f
Remove docker and sp3 from user facing docs (#110)
EMaksy b4a72c2
Update Trento support plugin content (#101)
dmpop f886d6d
Local Documentation Preview with Docker (#114)
EMaksy e12398f
Fix TRNT-3957 (#96)
dmpop 539f95a
Restructure trento install section (#99)
EMaksy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,18 @@ | ||
| include::product-attributes.adoc[] | ||
| :trento: Trento | ||
|
|
||
| == Containerized deployment | ||
| === Containerized deployment | ||
| :revdate: 2025-08-05 | ||
|
|
||
|
|
||
| A containerized deployment of {trserver} is identical to the systemd | ||
| A containerized deployment of {trento} is identical to the systemd | ||
| deployment. However, the web and check engine components are deployed as | ||
| Docker containers. | ||
|
|
||
| Follow the steps in <<sec-systemd-deployment>>, but skip the *Install | ||
| Trento using RPM packages* step and follow the procedures as described below. | ||
| Follow the steps in link:https://www.trento-project.io/docs/user-guide/trento-install-server.html#sec-systemd-deployment[systemd installation], but skip the *Install | ||
abravosuse marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| {trento} using RPM packages* step and follow the procedures as described below. | ||
|
|
||
| === Install Trento using Docker | ||
| ==== Install Trento using Docker | ||
|
|
||
| ==== Install Docker container runtime | ||
| ===== Install Docker container runtime | ||
|
|
||
| . Enable the containers module (replace `15.x` with the correct Service Pack version): | ||
| + | ||
|
|
@@ -35,9 +34,9 @@ zypper install docker | |
| systemctl enable --now docker | ||
| ---- | ||
|
|
||
| ==== Create a dedicated Docker network for Trento | ||
| ==== Create a dedicated Docker network for {trento} | ||
|
|
||
| . Create the Trento Docker network: | ||
| . Create the {trento} Docker network: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
|
|
@@ -61,7 +60,7 @@ The output should be similar to this (the exact address may vary): | |
| . Open the _/var/lib/pgsql/data/pg_hba.conf_ file for editing and replace `0.0.0.0/0` with the address returned by the command in the previous step. | ||
| . Restart the PostgreSQL server using the `systemctl restart postgresql` command. | ||
|
|
||
| ==== Install Trento on Docker | ||
| ==== Install {trento} on Docker | ||
|
|
||
| . Create secret environment variables: | ||
| + | ||
|
|
@@ -104,6 +103,8 @@ docker run -d --name wanda \ | |
| -e ACCESS_TOKEN_ENC_SECRET=$ACCESS_TOKEN_ENC_SECRET \ | ||
| -e AMQP_URL=amqp://trento_user:[email protected]/vhost \ | ||
| -e DATABASE_URL=ecto://wanda_user:[email protected]/wanda \ | ||
| -e OAS_SERVER_URL=https://trento.example.com/wanda \ | ||
| -e AUTH_SERVER_URL=http://localhost:4000 \ | ||
| --restart always \ | ||
| --entrypoint /bin/sh \ | ||
| registry.suse.com/trento/trento-wanda:latest \ | ||
|
|
@@ -121,7 +122,7 @@ the UI. | |
| [NOTE] | ||
| ==== | ||
| Add `+CHARTS_ENABLED=false+` if Prometheus is not installed, or you do | ||
| not want to use Trento's charts functionality. | ||
| not want to use {trento}'s charts functionality. | ||
| ==== | ||
| + | ||
| [source,bash] | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| == Local Documentation Preview with Docker | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This part is just developer docs for new way of preview antora with docker |
||
|
|
||
| Easy way to locally preview documentation changes without installing repository dependencies (like Node.js or Antora) on your host machine. | ||
|
|
||
| === Prerequisites | ||
|
|
||
| * Docker Engine (or Podman). | ||
| * Docker Compose. | ||
|
|
||
| === Workflow | ||
|
|
||
| . **Start the Preview** | ||
| + | ||
| To start the build process inside a container, navigate to the root directory of the repository and run the following command: | ||
| + | ||
| [source,bash] | ||
| ---- | ||
| docker compose up | ||
| ---- | ||
| + | ||
|
|
||
| . **Check the Docs** | ||
| + | ||
| Once the build is complete and the server starts, open your browser and navigate to: | ||
| + | ||
| http://localhost:3000 | ||
|
|
||
| . **Review and Rebuild** | ||
| + | ||
| The container builds the site and serves it. To view new changes: | ||
| + | ||
| * Stop the container (press `Ctrl+C`). | ||
| * Make your changes to the source files. | ||
| * Run `docker compose up` again. | ||
| + | ||
| The container will rebuild the documentation with your new changes for preview. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| services: | ||
| trento-docs: | ||
| image: node:20-bullseye | ||
| volumes: | ||
| - .:/workspace:z | ||
| - trento-docs-node_modules:/workspace/trento-docs-site/node_modules | ||
| working_dir: /workspace/trento-docs-site | ||
| command: > | ||
| bash -lc " | ||
| npm install --no-save antora http-server && | ||
| npx antora antora-playbook.yml && | ||
| npx http-server build/trento-docs-site-public/ -c-1 -p 3000 | ||
| " | ||
| ports: | ||
| - "3000:3000" | ||
|
|
||
| volumes: | ||
| trento-docs-node_modules: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.