From ac028e0350a03276865eab26560bb529b29ef24e Mon Sep 17 00:00:00 2001 From: Prabha Kylasamiyer Sundara Rajan Date: Thu, 16 Apr 2026 16:42:10 +0530 Subject: [PATCH 1/4] MTA-6811, 6812, 6813 CQA April Developer Lightspeed work Signed-off-by: Prabha Kylasamiyer Sundara Rajan --- .../assembly_getting-started.adoc | 25 --------- ...sembly_solution-server-configurations.adoc | 53 ------------------- .../con_developer-lightspeed-logs.adoc | 4 +- .../con_developer-lightspeed-pathways.adoc | 2 +- .../con_installation.adoc | 4 +- .../con_intro-to-developer-lightspeed.adoc | 2 +- .../con_llm-service-openshift-ai.adoc | 2 +- .../con_prerequisites.adoc | 4 +- .../con_solution_server.adoc | 2 +- .../proc_apply-rag-resolution.adoc | 2 +- ...ing-developer-lightspeed-ide-settings.adoc | 6 +-- ...onfiguring-developer-profile-settings.adoc | 4 +- .../proc_running-agent-analysis.adoc | 4 +- .../proc_running-rag-analysis.adoc | 2 +- .../proc_tackle-enable-dev-lightspeed.adoc | 2 +- .../ref_example-code-suggestion.adoc | 12 ++--- .../ref_llm-provider-configurations.adoc | 4 +- 17 files changed, 28 insertions(+), 106 deletions(-) delete mode 100644 assemblies/developer-lightspeed-guide/assembly_getting-started.adoc delete mode 100644 docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc diff --git a/assemblies/developer-lightspeed-guide/assembly_getting-started.adoc b/assemblies/developer-lightspeed-guide/assembly_getting-started.adoc deleted file mode 100644 index 5afda620..00000000 --- a/assemblies/developer-lightspeed-guide/assembly_getting-started.adoc +++ /dev/null @@ -1,25 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2025-05-28 - -ifdef::context[:parent-context-of-getting-started: {context}] - -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="getting-started"] -endif::[] -ifdef::context[] -[id="getting-started_{context}"] -endif::[] -= Getting started with {mta-dl-plugin} - -:context: getting-started - -[role="_abstract"] -The Getting started section contains information to walk you through the prerequisites, persistent volume requirements, installation, and workflows that help you to decide how you want to use {mta-dl-full}. - - - -ifdef::parent-context-of-getting-started[:context: {parent-context-of-getting-started}] -ifndef::parent-context-of-getting-started[:!context:] - diff --git a/docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc b/docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc deleted file mode 100644 index fbec58ad..00000000 --- a/docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc +++ /dev/null @@ -1,53 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2025-03-17 - -ifdef::context[:parent-context-of-solution-server-configurations: {context}] - -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="solution-server"] -endif::[] -ifdef::context[] -[id="solution-server_{context}"] -endif::[] -= What is the Solution Server -:context: solution-server - -[role=_abstract] -Solution Server is a component that allows {mta-dl-plugin} to build a collective memory of source code changes from all analysis performed in an organization. When you request code fix for issues in the Visual Studio (VS) Code, the Solution Server augments previous patterns of how source code changed to resolve issues (also called solved examples) that were similar to those in the current file, and suggests a resolution that has a higher confidence level derived from previous solutions. After you accept a suggested code fix, the Solution Server works with the large language model (LLM) to improve the hints about the issue that becomes part of the context. An improved context enables the LLM to generate more reliable code fix suggestions in future cases. - -The Solution Server delivers two primary benefits to users: - -* *Contextual Hints*: It surfaces examples of past migration solutions — including successful user modifications and accepted fixes — offering actionable hints for difficult or previously unsolved migration problems. -* *Migration Success Metrics*: It exposes detailed success metrics for each migration rule, derived from real-world usage data. These metrics can be used by IDEs or automation tools to present users with a “confidence level” or likelihood of {mta-dl-plugin} successfully migrating a given code segment. - -Solution Server is an optional component in {mta-dl-plugin}. You must complete the following configurations before you can place a code resolution request. - -:FeatureName: Solution Server -[IMPORTANT] -==== -[subs="attributes+"] -{FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. - -For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. -==== -:!FeatureName: - -.Configurable large language models and providers in the Tackle custom resource -|=== -| LLM Provider (Tackle CR value) | Large language model examples for Tackle CR configuration - -|{ocp-name} AI platform| Models deployed in an OpenShift AI cluster that can be accessed by using Open AI-compatible API -| Open AI (`openai`) | `gpt-4`, `gpt-4o`, `gpt-4o-mini`, `gpt-3.5-turbo` -| Azure OpenAI (`azure_openai`) | `gpt-4`, `gpt-35-turbo` -| Amazon Bedrock (`bedrock`) | `anthropic.claude-3-5-sonnet-20241022-v2:0`, `meta.llama3-1-70b-instruct-v1:0` -| Google Gemini (`google`) | `gemini-2.0-flash-exp`, `gemini-1.5-pro` -| Ollama (`ollama`) | `llama3.1`, `codellama`, `mistral` - -|=== - -ifdef::parent-context-of-solution-server[:context: {parent-context-of-solution-server}] -ifndef::parent-context-of-solution-server[:!context:] - -:!solution-server: \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc b/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc index 57e269af..197dd5a1 100644 --- a/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc +++ b/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc @@ -15,7 +15,7 @@ Extension logs are stored as `extension.log` with automatic rotation. The maximu == Archiving the logs -To archive the logs as a zip file, type `{ProductShortName}: Generate Debug Archive` in the VS Code Command Palette and select the information type that must be archived as a log file. +To archive the logs as a zip file, type `{ProductShortName}: Generate Debug Archive` in the Visual Studio Code Command Palette and select the information type that must be archived as a log file. The archive command allows capturing all relevant log files in a zip archive at the specified location in your project. By default, you can access the archived logs in the .vscode directory of your project. @@ -35,4 +35,4 @@ You can access the logs in the following ways: * *Output panel*: Select `{mta-dl-plugin}` from the drop-down menu. -* *Webview logs*: You can also inspect webview content by using the webview logs. To access the webview logs, type `Open Webview Developer Tools` in the VS Code Command Palette. \ No newline at end of file +* *Webview logs*: You can also inspect webview content by using the webview logs. To access the webview logs, type `Open Webview Developer Tools` in the Visual Studio Code Command Palette. \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc b/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc index a7fb02f4..526ce7ae 100644 --- a/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc +++ b/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc @@ -43,7 +43,7 @@ As a Migrator, you can complete the following workflow to use the Agent AI mode [id="llm-proxy-workflow_{context}"] == Workflow to use the LLM through the proxy service -You can allow client endpoints, for example, the MTA Visual Studio Code extension, to use the proxy service to access the large language models (LLMs). The client uses Keycloak credentials to authenticate to the MTA Hub. To authenticate to the LLM, the client sends a JSON Web Token (JWT) issued by Keycloak to the proxy service. The proxy service validates the client's JWT against the Hub's Keycloak instance. +You can allow client endpoints, for example, the {ProductShortName} Visual Studio Code extension, to use the proxy service to access the large language models (LLMs). The client uses Keycloak credentials to authenticate to the {ProductShortName} Hub. To authenticate to the LLM, the client sends a JSON Web Token (JWT) issued by Keycloak to the proxy service. The proxy service validates the client's JWT against the Hub's Keycloak instance. The proxy service completes a separate authentication process to access the LLM through an Administrator-controlled endpoint. The proxy service authenticates to the LLM by using the cluster secret that contains the LLM API key configured by the Administrator. Thus, the proxy service allows Administrators to create, manage, and rotate LLM API keys without the need to share the LLM key with multiple client endpoints. diff --git a/docs/topics/developer-lightspeed/con_installation.adoc b/docs/topics/developer-lightspeed/con_installation.adoc index 99390b64..9482ad59 100644 --- a/docs/topics/developer-lightspeed/con_installation.adoc +++ b/docs/topics/developer-lightspeed/con_installation.adoc @@ -7,6 +7,6 @@ = Installation [role="_abstract"] -You can install the {ProductFullName} 8.0.0 Visual Studio (VS) Code plug-in from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[VS Code marketplace]. +You can install the {ProductFullName} 8.0.0 Visual Studio Code plug-in from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code marketplace]. -You can use the {ProductShortName} VS Code plug-in to perform analysis and optionally enable {mta-dl-full} to use generative AI capabilities. You can fix code issues before migrating the application to target technologies by using the generative AI capabilities. \ No newline at end of file +You can use the {ProductShortName} Visual Studio Code plug-in to perform analysis and optionally enable {mta-dl-full} to use generative AI capabilities. You can fix code issues before migrating the application to target technologies by using the generative AI capabilities. \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc index f8ce3746..62ba5d3b 100644 --- a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc +++ b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc @@ -31,7 +31,7 @@ Migrators do duplicate work by resolving issues that are repeated across applica //You can consider using the demo mode for running {mta-dl-plugin} when you need to perform analysis but have a limited network connection for {mta-dl-plugin} to sync with the LLM. The demo mode stores the input data as a hash and past LLM calls in a cache. The cache is stored in a chosen location in the your file system for later use. The hash of the inputs is used to determine which LLM call must be used in the demo mode. After you enable the demo mode and configure the path to your cached LLM calls in the {mta-dl-plugin} settings, you can rerun an analysis for the same set of files using the responses to a previous LLM call. -:FeatureName: Developer Lightspeed for MTA +:FeatureName: Developer Lightspeed for {ProductShortName} [IMPORTANT] ==== diff --git a/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc b/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc index 6eb94c7d..71b6b939 100644 --- a/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc +++ b/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc @@ -30,4 +30,4 @@ An example workflow for configuring an LLM service on {ocp-name} AI broadly requ ** Configure an OpenAI API key ** Update the OpenAI API key and the base URL in `provider-settings.yaml`. -See xref:llm-provider-settings_{context}[Configuring LLM provider settings] to configure the base URL and the LLM API key in the {mta-dl-plugin} VS Code extension. \ No newline at end of file +See xref:llm-provider-settings_{context}[Configuring LLM provider settings] to configure the base URL and the LLM API key in the {mta-dl-plugin} Visual Studio Code extension. \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_prerequisites.adoc b/docs/topics/developer-lightspeed/con_prerequisites.adoc index 89f601f8..5e3367a8 100644 --- a/docs/topics/developer-lightspeed/con_prerequisites.adoc +++ b/docs/topics/developer-lightspeed/con_prerequisites.adoc @@ -7,7 +7,7 @@ = Prerequisites [role="_abstract"] -This section lists the prerequisites required to successfully use the generative AI features in the {mta-dl-plugin} Visual Studio (VS) Code extension. +This section lists the prerequisites required to successfully use the generative AI features in the {mta-dl-plugin} Visual Studio Code extension. Before you install {mta-dl-plugin}, you must: @@ -27,7 +27,7 @@ The {ProductShortName} Operator is mandatory if you plan to enable the Solution * Create an API key for an LLM. + -You must enter the provider value and model name in Tackle CR to enable generative AI configuration in the {ProductShortName} VS Code plugin. +You must enter the provider value and model name in Tackle CR to enable generative AI configuration in the {ProductShortName} Visual Studio Code plugin. + .Configurable large language models and providers |=== diff --git a/docs/topics/developer-lightspeed/con_solution_server.adoc b/docs/topics/developer-lightspeed/con_solution_server.adoc index 7921e32c..56422041 100644 --- a/docs/topics/developer-lightspeed/con_solution_server.adoc +++ b/docs/topics/developer-lightspeed/con_solution_server.adoc @@ -15,7 +15,7 @@ The Solution Server augments previous patterns of how source code changed to res The Solution Server delivers two primary benefits to users: -* *Contextual Hints*: It surfaces examples of past migration solutions — including successful user modifications and accepted fixes — offering actionable hints for difficult or previously unsolved migration problems. +* *Contextual Hints*: It surfaces examples of past migration solutions, including successful user modifications and accepted fixes, offering actionable hints for difficult or previously unsolved migration problems. * *Migration Success Metrics*: It exposes detailed success metrics for each migration rule, derived from real-world usage data. These metrics can be used by IDEs or automation tools to present users with a “confidence level” or likelihood of {mta-dl-plugin} successfully migrating a given code segment. When you use the Solution Server, you can view a diff of the updated portions of the code and the original source code to do a manual review. In a manual review of the suggested AI resolutions, you can accept, reject, or edit the suggested code changes. diff --git a/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc b/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc index 7f5734cd..b3a690f0 100644 --- a/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc +++ b/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc @@ -12,7 +12,7 @@ You can review the code updates and edit the suggested code resolutions before a .Prerequisites -* You opened a Java project in your VS Code workspace. +* You opened a Java project in your Visual Studio Code workspace. * You configured a profile on the *{ProductShortName} Analysis View* page. * You ran an analysis after enabling the Solution Server. diff --git a/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc b/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc index 318cc1ad..90b7bc4a 100644 --- a/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc +++ b/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc @@ -6,7 +6,7 @@ = Configuring the {mta-dl-plugin} IDE settings [role="_abstract"] -After you install the {ProductShortName} extension in Visual Studio (VS) Code, you must provide your large language model (LLM) credentials to activate {mta-dl-plugin} settings in Visual Studio (VS) Code. +After you install the {ProductShortName} extension in Visual Studio Code, you must provide your large language model (LLM) credentials to activate {mta-dl-plugin} settings in Visual Studio Code. {mta-dl-plugin} settings are applied to all AI-assisted analyses that you perform by using the {ProductShortName} extension. The extension settings can be broadly categorized into debugging and logging, {mta-dl-plugin} settings, analysis settings, and Solution Server settings. @@ -22,7 +22,7 @@ In addition to the overall prerequisites, you have configured the following: + .. Click `Extensions > {ProductShortName} Extension for VSCode > Settings` + -.. Type `Ctrl + Shift + P` or `Cmd + Shift + P` on the search bar to open the Command Palette and enter `Preferences: Open Settings (UI)`. Go to `Extensions > MTA` to open the settings page. +.. Type `Ctrl + Shift + P` or `Cmd + Shift + P` on the search bar to open the Command Palette and enter `Preferences: Open Settings (UI)`. Go to `Extensions > {ProductShortName}` to open the settings page. + . Configure the settings described in the following table: + @@ -41,7 +41,7 @@ In addition to the overall prerequisites, you have configured the following: |Trace directory|Configure the absolute path to the directory that contains the saved LLM interaction. |Trace enabled|Enable to trace {ProductShortName} communication with the LLM model. Traces are stored in the trace directory that you configured. |Demo mode|Enable to run {mta-dl-plugin} in demo mode that uses the LLM responses saved in the `cache` directory for analysis. -|Debug:Webview|Enable debug level logging for Webview message handling in VS Code. +|Debug:Webview|Enable debug level logging for Webview message handling in Visual Studio Code. |==== diff --git a/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc b/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc index bb2a194f..066bc917 100644 --- a/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc +++ b/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc @@ -6,14 +6,14 @@ = Configuring the {mta-dl-plugin} profile settings [role="_abstract"] -You can use the Visual Studio (VS) Code plugin to run an analysis to discover issues in the code. You can optionally enable {mta-dl-full} to get AI-assisted code suggestions. +You can use the Visual Studio Code plugin to run an analysis to discover issues in the code. You can optionally enable {mta-dl-full} to get AI-assisted code suggestions. To generate code changes using {mta-dl-plugin}, you must configure a profile that contains all the necessary configurations, such as source and target technologies and the API key to connect to your chosen large language model (LLM). .Prerequisites * You completed the Solution Server configurations in Tackle custom resource if you opt to use the Solution Server. -* You opened a Java project in your VS Code workspace. +* You opened a Java project in your Visual Studio Code workspace. .Procedure diff --git a/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc b/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc index 00b82ffd..93b0d3a4 100644 --- a/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc +++ b/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc @@ -14,14 +14,14 @@ When using the agent mode, you can reject the changes or discontinue the stream .Prerequisites -* You opened a Java project in your VS Code workspace. +* You opened a Java project in your Visual Studio Code workspace. * You configured an analysis profile on the *{ProductShortName} Analysis View* page. .Procedure . Verify that agent mode is enabled in one of the following ways: + -.. Type `Ctrl + Shift + P` in VS Code search (Linux/Windows system) and `Cmd + Shift + P` for Mac to go to the command palette. +.. Type `Ctrl + Shift + P` in Visual Studio Code search (Linux/Windows system) and `Cmd + Shift + P` for Mac to go to the command palette. .. Enter `Preferences: Open User Settings (JSON)` to open the `settings.json` file. .. Ensure that `mta-vscode-extension.genai.agentMode` is set to `true`. + diff --git a/docs/topics/developer-lightspeed/proc_running-rag-analysis.adoc b/docs/topics/developer-lightspeed/proc_running-rag-analysis.adoc index 510290cd..ddfa3ed0 100644 --- a/docs/topics/developer-lightspeed/proc_running-rag-analysis.adoc +++ b/docs/topics/developer-lightspeed/proc_running-rag-analysis.adoc @@ -10,7 +10,7 @@ You can run a static code analysis of an application with or without enabling th .Prerequisites -* You opened a Java project in your VS Code workspace. +* You opened a Java project in your Visual Studio Code workspace. * You configured an analysis profile on the *{ProductShortName} Analysis View* page. .Procedure diff --git a/docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc b/docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc index 3ad42a60..4f92f2a1 100644 --- a/docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc +++ b/docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc @@ -8,7 +8,7 @@ [role="_abstract"] Solution Server integrates with the {ProductShortName} Hub backend component to use the database and volumes necessary to store and retrieve the solved examples. -To enable Solution Server and other AI configurations in the {mta-dl-full} VS Code extension, you must modify the Tackle custom resource (CR) with additional parameters. +To enable Solution Server and other AI configurations in the {mta-dl-full} Visual Studio Code extension, you must modify the Tackle custom resource (CR) with additional parameters. [NOTE] ==== diff --git a/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc b/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc index 65842d39..51bf018d 100644 --- a/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc +++ b/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc @@ -10,19 +10,19 @@ This example will walk you through generating code fixes for a Java application .Procedure -. Open the `my-Java` project in Visual Studio (VS) Code. +. Open the `my-Java` project in Visual Studio Code. -. Download the {mta-dl-full} extension from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[VS Code marketplace]. +. Download the {mta-dl-full} extension from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code marketplace]. . Type `Ctrl+Shift+P` (Windows and Linux systems) or `Cmd+Shift+P` (Mac systems). -. Type `Preferences: Open Settings (UI)` in the Command Palette to open the VS Code settings and select `Extensions > {ProductShortName}`. +. Type `Preferences: Open Settings (UI)` in the Command Palette to open the Visual Studio Code settings and select `Extensions > {ProductShortName}`. . Select `Gen AI:Agent Mode`. . In the {mta-dl-plugin} extension, click `Open Analysis View`. -. Type `MTA: Manage Analysis Profile` in the Command Palette and configure the following fields: +. Type `{ProductShortName}: Manage Analysis Profile` in the Command Palette and configure the following fields: ** *Profile Name*: Type a profile name @@ -30,7 +30,7 @@ This example will walk you through generating code fixes for a Java application ** *Custom Rules*: Select custom rules if you want to include them while running the analysis. By default, {mta-dl-plugin} enables *Use Default Rules* for `quarkus`. -. Type `MTA: Open the Gen AI model provider configuration file` in the Command Palette to configure the following in the `provider-settings` file: +. Type `{ProductShortName}: Open the Gen AI model provider configuration file` in the Command Palette to configure the following in the `provider-settings` file: + [source, yaml] ---- @@ -57,7 +57,7 @@ You must change the `provider-setting` configuration if you plan to use a differ + {ProductShortName} identifies the issues in the code. -. Click the solutions icon (image:solutions-icon-new.png[]) in an issue to request suggestions to resolve the issue. +. Click the solutions icon (image:solutions-icon-new.png[Click solutions icon]) in an issue to request suggestions to resolve the issue. + {mta-dl-plugin} streams the issue description, a preview of the code changes that resolve the issue, and the file(s) in which the changes are to be made. + diff --git a/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc b/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc index 8280c6ea..b5fc45b4 100644 --- a/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc +++ b/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc @@ -11,9 +11,9 @@ The `provider-settings.yaml` file contains a list of LLM providers that are supported by default. The mandatory environment variables are different for each LLM provider. Depending on the provider that you choose, you can configure additional environment variables for a model in the `provider-settings.yaml` file. You can also enter a new provider with the required environment variables, the base URL, and the model name. -The provider settings file is available in the {mta-dl-plugin} Visual Studio (VS) Code extension. +The provider settings file is available in the {mta-dl-plugin} Visual Studio Code extension. -Access the `provider-settings.yaml` from the VS Code Command Palette by typing `Open the GenAI model provider configuration file`. +Access the `provider-settings.yaml` from the Visual Studio Code Command Palette by typing `Open the GenAI model provider configuration file`. [NOTE] ==== From 9ee901ba5d7cdff47b97c102c13fc05339510241 Mon Sep 17 00:00:00 2001 From: Prabha Kylasamiyer Sundara Rajan Date: Tue, 21 Apr 2026 13:28:25 +0530 Subject: [PATCH 2/4] Updated requirements in MTA-6814, MTA-6815, and MTA-6816 Signed-off-by: Prabha Kylasamiyer Sundara Rajan --- .github/.gitignore | 26 + .github/styles/RedHat/Abbreviations.yml | 2 +- .github/styles/RedHat/CaseSensitiveTerms.yml | 35 +- .github/styles/RedHat/Conjunctions.yml | 4 +- .github/styles/RedHat/ConsciousLanguage.yml | 4 +- .github/styles/RedHat/Contractions.yml | 2 +- .github/styles/RedHat/Definitions.yml | 59 +- .github/styles/RedHat/DoNotUseTerms.yml | 4 +- .github/styles/RedHat/Ellipses.yml | 2 +- .github/styles/RedHat/EmDash.yml | 2 +- .github/styles/RedHat/GitLinks.yml | 5 +- .github/styles/RedHat/HeadingPunctuation.yml | 2 +- .github/styles/RedHat/Headings.yml | 30 +- .github/styles/RedHat/Hyphens.yml | 4 +- .../styles/RedHat/MergeConflictMarkers.yml | 2 +- .github/styles/RedHat/ObviousTerms.yml | 8 +- .github/styles/RedHat/OxfordComma.yml | 2 +- .github/styles/RedHat/PascalCamelCase.yml | 49 +- .github/styles/RedHat/PassiveVoice.yml | 3 +- .../styles/RedHat/ProductCentricWriting.yml | 2 +- .github/styles/RedHat/ReadabilityGrade.yml | 2 +- .github/styles/RedHat/ReleaseNotes.yml | 2 +- .github/styles/RedHat/RepeatedWords.yml | 2 +- .github/styles/RedHat/SelfReferentialText.yml | 2 +- .github/styles/RedHat/SentenceLength.yml | 2 +- .github/styles/RedHat/SimpleWords.yml | 6 +- .github/styles/RedHat/Slash.yml | 108 +- .github/styles/RedHat/Spacing.yml | 2 +- .github/styles/RedHat/Spelling.yml | 552 +- .github/styles/RedHat/TermsErrors.yml | 23 +- .github/styles/RedHat/TermsSuggestions.yml | 20 +- .github/styles/RedHat/TermsWarnings.yml | 4 +- .github/styles/RedHat/UserReplacedValues.yml | 4 +- .github/styles/RedHat/Using.yml | 5 +- .../RedHat/dictionaries/en_US-RedHat.aff | 15 + .../RedHat/dictionaries/en_US-RedHat.dic | 5882 +++++++++++++++++ .../styles/RedHat/dictionaries/wordlist.txt | 4058 ++++++++++++ .github/workflows/vale.yml | 7 +- ...analyzing-applications-using-profiles.adoc | 2 +- ...sembly_analyzing-nonjava-applications.adoc | 1 - .../cli-guide/assembly_generating-assets.adoc | 8 +- .../assembly_reference-material.adoc | 2 +- ...sembly_configuring-dev-lightspeed-ide.adoc | 12 +- .../assembly_configuring_llm.adoc | 10 +- .../assembly_getting-started.adoc | 44 + .../assembly_run-dev-lightspeed-analysis.adoc | 10 +- .../assembly_understanding_dl.adoc | 10 +- .../release-notes/assembly_mta-8-1-0.adoc | 11 +- .../release-notes/assembly_mta-8-1-1.adoc | 24 + .../release-notes/assembly_mta-8-1-2.adoc | 24 + .../release-notes/assembly_mta-8-1.adoc | 27 + .../assembly_asset-generation-ui.adoc | 26 +- .../assembly_configuring-credentials.adoc | 10 +- .../assembly_configuring-mta-instance.adoc | 12 +- .../assembly_configuring-repositories.adoc | 8 +- .../assembly_managing-applications.adoc | 2 +- .../assembly_mta-custom-questionnaire.adoc | 8 +- .../assembly_working-with-archetypes.adoc | 12 +- docs/cli-guide/master.adoc | 15 +- docs/developer-lightspeed-guide/master.adoc | 14 +- docs/release-notes/master.adoc | 2 +- docs/topics/about-ide-addons.adoc | 2 +- .../assembly_getting-started.adoc | 44 - .../developer-lightspeed/con_agent-ai.adoc | 10 +- .../con_developer-lightspeed-logs.adoc | 10 +- .../con_developer-lightspeed-pathways.adoc | 53 +- .../developer-lightspeed/con_dl-context.adoc | 16 +- .../con_installation.adoc | 7 +- .../con_intro-to-developer-lightspeed.adoc | 26 +- .../con_llm-service-openshift-ai.adoc | 5 +- .../con_persistent-volumes.adoc | 8 +- .../con_prerequisites.adoc | 8 +- .../con_solution_server.adoc | 18 +- .../proc_apply-rag-resolution.adoc | 8 +- ...ing-developer-lightspeed-ide-settings.adoc | 22 +- ...onfiguring-developer-profile-settings.adoc | 34 +- .../proc_configuring-llm-podman-desktop.adoc | 12 +- .../proc_running-agent-analysis.adoc | 19 +- .../proc_tackle-enable-dev-lightspeed.adoc | 80 - .../proc_tackle-enable-llm-proxy.adoc | 20 +- .../proc_tackle-llm-secret.adoc | 37 +- .../developer-lightspeed/ref_dl-benefits.adoc | 10 +- .../ref_example-code-suggestion.adoc | 12 +- .../ref_llm-provider-configurations.adoc | 11 +- docs/topics/important-links.adoc | 2 +- docs/topics/mta-cli/con_intro-to-the-cli.adoc | 6 +- .../proc_accessing-analysis-report.adoc | 2 +- .../proc_analyze-unsupported-provider.adoc | 7 +- .../proc_analyzing-app-with-profile.adoc | 35 +- ..._analyzing-multiple-apps-with-mta-cli.adoc | 4 +- ...roc_analyzing-single-app-with-mta-cli.adoc | 2 +- .../proc_assets-generation-example.adoc | 20 + ...proc_concealing-sensitive-information.adoc | 16 + ...enerate_deployment_assets_values_file.adoc | 15 +- .../proc_generating-deployment-manifest.adoc | 31 +- .../proc_performing-a-live-discovery.adoc | 4 + ...viewing-analysis-issues-and-incidents.adoc | 10 +- ...roc_running-the-containerless-mta-cli.adoc | 11 +- .../mta-cli/ref_analysis-report-sections.adoc | 2 +- .../ref_available-openrewrite-recipes.adoc | 2 +- ...ref_discover-generate-command-options.adoc | 4 +- .../ref_discovery_manifest_sample.adoc | 16 +- .../mta-cli/ref_effort-level-estimation.adoc | 2 +- .../ref_modify-application-profile.adoc | 26 +- .../mta-cli/ref_mta-cli-analyze-flags.adoc | 4 +- docs/topics/mta-cli/ref_mta-tech-tags.adoc | 4 +- .../ref_openrewrite-command-options.adoc | 2 +- .../ref_supported-migration-paths.adoc | 4 +- .../con_assessment-module-features.adoc | 12 +- .../mta-ui/con_mta-default-questionnaire.adoc | 10 +- .../mta-ui/proc_adding-applications.adoc | 18 +- ...oc_adding-source-platform-application.adoc | 2 +- .../mta-ui/proc_assessing-an-application.adoc | 2 +- .../mta-ui/proc_assessing-an-archetype.adoc | 4 +- ...g-and-running-an-application-analysis.adoc | 44 +- .../proc_configuring-asset-repository.adoc | 2 +- .../mta-ui/proc_configuring-git-repos.adoc | 3 +- .../proc_configuring-jira-credentials.adoc | 4 +- .../mta-ui/proc_configuring-maven-repo.adoc | 8 +- ...g-profile-for-an-application-analysis.adoc | 4 +- .../proc_configuring-subversion-repos.adoc | 3 +- .../proc_configuring-target-profiles.adoc | 4 +- .../proc_creating-a-business-service.adoc | 16 +- .../proc_creating-a-jira-connection.adoc | 30 +- .../mta-ui/proc_creating-a-stakeholder.adoc | 50 +- docs/topics/mta-ui/proc_creating-a-tag.adoc | 32 +- .../proc_creating-application-tags.adoc | 4 +- ...eating-jira-issues-for-migration-wave.adoc | 17 +- .../mta-ui/proc_creating-migration-waves.adoc | 2 +- .../mta-ui/proc_creating-source-platform.adoc | 2 +- .../mta-ui/proc_defining-an-archetype.adoc | 2 +- .../proc_displaying-automated-tasks.adoc | 6 +- .../proc_downloading-an-analysis-report.adoc | 2 +- .../proc_generating-deployment-assets.adoc | 14 +- ...roc_generating-discovery-manifest-web.adoc | 9 +- .../mta-ui/proc_importing-an-app-list.adoc | 4 +- .../mta-ui/proc_reviewing-a-task-log.adoc | 2 +- .../proc_reviewing-an-analysis-report.adoc | 2 +- .../mta-ui/proc_reviewing-an-archetype.adoc | 18 +- .../proc_reviewing-assessment-report.adoc | 4 +- ...roc_running-an-analysis-using-profile.adoc | 27 +- .../ref_custom-questionnaire-fields.adoc | 37 +- .../ref_fixed-issues-8-1-1.adoc | 21 + .../ref_fixed-issues-8-1-2.adoc | 15 + .../topics/templates/document-attributes.adoc | 10 +- .../proc_installing-vscode-extension.adoc | 23 +- method-discover.adoc | 4 +- 147 files changed, 11143 insertions(+), 1270 deletions(-) create mode 100644 .github/.gitignore create mode 100644 .github/styles/RedHat/dictionaries/en_US-RedHat.aff create mode 100644 .github/styles/RedHat/dictionaries/en_US-RedHat.dic create mode 100644 .github/styles/RedHat/dictionaries/wordlist.txt rename {docs/topics/developer-lightspeed => assemblies/developer-lightspeed-guide}/assembly_configuring-dev-lightspeed-ide.adoc (50%) rename {docs/topics/developer-lightspeed => assemblies/developer-lightspeed-guide}/assembly_configuring_llm.adoc (57%) create mode 100644 assemblies/developer-lightspeed-guide/assembly_getting-started.adoc rename {docs/topics/developer-lightspeed => assemblies/developer-lightspeed-guide}/assembly_run-dev-lightspeed-analysis.adoc (78%) rename {docs/topics/developer-lightspeed => assemblies/developer-lightspeed-guide}/assembly_understanding_dl.adoc (66%) create mode 100644 assemblies/release-notes/assembly_mta-8-1-1.adoc create mode 100644 assemblies/release-notes/assembly_mta-8-1-2.adoc create mode 100644 assemblies/release-notes/assembly_mta-8-1.adoc delete mode 100644 docs/topics/developer-lightspeed/assembly_getting-started.adoc delete mode 100644 docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc create mode 100644 docs/topics/release-notes-topics/ref_fixed-issues-8-1-1.adoc create mode 100644 docs/topics/release-notes-topics/ref_fixed-issues-8-1-2.adoc diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 00000000..83ab1aa2 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1,26 @@ +Gemfile.lock +*.swp +.asciidoctor +_package +_preview +drupal-build +architecture/core_concepts/images/docker-diagram.png +architecture/core_concepts/images/docker-diagram.png.cache +dev_guide/builds/images/chained-build.png +dev_guide/builds/images/chained-build.png.cache +.DS_Store +.idea +.venv +.gem +bin +commercial_package +.vscode +.vale/styles/AsciiDoc +.vale/styles/OpenShiftAsciiDoc +.vale/styles/RedHat +.vale/styles/AsciiDocDITA +.vale/styles/write-good +.github/styles/ + +*.build +build/ \ No newline at end of file diff --git a/.github/styles/RedHat/Abbreviations.yml b/.github/styles/RedHat/Abbreviations.yml index 102fee41..ba6c0212 100644 --- a/.github/styles/RedHat/Abbreviations.yml +++ b/.github/styles/RedHat/Abbreviations.yml @@ -1,7 +1,7 @@ --- extends: existence level: error -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/abbreviations/ +link: https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#abbreviations message: "Do not use periods in all-uppercase abbreviations such as '%s'." nonword: true # source: "IBM - Periods with abbreviations, p. 5" diff --git a/.github/styles/RedHat/CaseSensitiveTerms.yml b/.github/styles/RedHat/CaseSensitiveTerms.yml index f6279863..5b1ffa41 100644 --- a/.github/styles/RedHat/CaseSensitiveTerms.yml +++ b/.github/styles/RedHat/CaseSensitiveTerms.yml @@ -2,7 +2,7 @@ extends: substitution ignorecase: false level: warning -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/casesensitiveterms/ +link: https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#case-sensitive-terms message: "Use '%s' rather than '%s'." action: name: replace @@ -11,6 +11,7 @@ swap: "(?__' - - '<[a-z_]+-[a-z_-]+>' \ No newline at end of file + - '<[a-z_]+-[a-z_-]+>' diff --git a/.github/styles/RedHat/Using.yml b/.github/styles/RedHat/Using.yml index 869cdc9b..8a128420 100644 --- a/.github/styles/RedHat/Using.yml +++ b/.github/styles/RedHat/Using.yml @@ -1,8 +1,9 @@ --- extends: sequence message: "Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness." -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/ +link: https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#using level: warning +scope: ~heading action: name: edit params: @@ -11,4 +12,4 @@ action: - "$1 by using" # replace tokens: - tag: NN|NNP|NNPS|NNS - - pattern: using + - pattern: \busing\b diff --git a/.github/styles/RedHat/dictionaries/en_US-RedHat.aff b/.github/styles/RedHat/dictionaries/en_US-RedHat.aff new file mode 100644 index 00000000..1a097310 --- /dev/null +++ b/.github/styles/RedHat/dictionaries/en_US-RedHat.aff @@ -0,0 +1,15 @@ +SET UTF-8 + +# Plural suffix flag +SFX S Y 6 +SFX S y ies [^aeiou]y +SFX S 0 s [aeiou]y +SFX S 0 es [sxz] +SFX S 0 es [sc]h +SFX S 0 s [^sc]h +SFX S 0 s [^sxzhy] + +# Possessive suffix flag +SFX P Y 2 +SFX P 0 's [^s] +SFX P 0 ' [s] diff --git a/.github/styles/RedHat/dictionaries/en_US-RedHat.dic b/.github/styles/RedHat/dictionaries/en_US-RedHat.dic new file mode 100644 index 00000000..03dc78f3 --- /dev/null +++ b/.github/styles/RedHat/dictionaries/en_US-RedHat.dic @@ -0,0 +1,5882 @@ +5881 +ACI/SP +ACL/SP +AEE/SP +ALUA/P +AMI/SP +ANP/SP +AOE/SP +API/SP +ARG/SP +ARN/SP +ASIC/SP +AWS/P +AZ/SP +Aacraid/P +Accessor/P +Ack/P +Acpi/P +Acpid/P +Actioned/P +Adaptec/P +Adata/P +Adcli/P +Addon/SP +Adm/P +Adminnetworkpolicy/SP +Adminpolicybasedexternalroute/SP +Adoc/P +Aduser/P +Advancecomp/P +Aescbc/P +Agentless/P +Agroal/P +Aidan/P +Aio/P +Airgapped/P +Akonadi/P +Alacarte/P +Alertingrule/SP +Alertmanager/SP +Alertmanagerconfig/SP +Alertrelabelconfig/SP +Alibaba/P +Allowlist/SP +Allowlisted/P +Allowlisting/P +Alwaysprompt/P +Amd/P +Andi/P +Annobin/P +Annocheck/P +Anonymized/P +Ansible/P +Answerfile/P +Antora/P +Aoe/SP +Apc/P +Apic/P +Apiguardian/P +Apirequestcount/SP +Apiserver/SP +Apisonator/P +Applixware/P +Approver/SP +Appstream/P +Arcee/P +Architected/P +Archivable/P +Arcmsr/P +Aresource/P +Arg/SP +Argo/P +Argocd/P +Arptable/SP +Artifactory/P +Aruna/P +Asciibinder/P +Asciidoc/P +Asciidoctor/P +Aspeed/P +Associable/P +Assumeno/P +Assumeyes/P +Async/P +Ata/P +Atime/P +Atlassian/P +Attacher/P +Attestor/SP +Attica/P +Attr/P +Audiofile/P +Auditability/P +Auditable/P +Auditctl/P +Auditd/P +Augenrule/SP +Ausearch/P +Authconfig/P +Authd/P +Authfile/SP +Authorizer/P +Authselect/P +Autoactivated/P +Autoactivation/P +Autoconfig/P +Autoconfiguration/P +Autoconfigure/P +Autodetected/P +Autodiscover/SP +Autodiscovering/P +Autodiscovery/P +Autof/SP +Autofilled/P +Autogenerate/P +Autogroup/SP +Autoinstall/P +Autoinstrumentation/P +Autokey/P +Autolink/P +Autom/P +Automapper/P +Automation/SP +Automember/P +Automembership/P +Automount/P +Autonumber/P +Autopart/P +Autopopulate/SP +Autopopulated/P +Autoreboot/P +Autorelabel/P +Autorid/P +Autosavet/SP +Autoscale/P +Autoscaled/P +Autoscaler/SP +Autoscaling/P +Autostart/P +Autosuspend/P +Autotl/SP +Avahi/P +Avc/P +Aws/P +Axio/SP +Az/SP +Azp/P +Azure/P +BANP/SP +BIOS/P +BMC/SP +BMH/SP +BOM/P +BSL/SP +Backend/SP +Backfill/SP +Backfilled/P +Backfilling/P +Backgrounded/P +Backhaul/P +Backlink/SP +Backoff/P +Backplane/P +Backport/SP +Backported/P +Backporting/P +Backpressure/P +Backstore/P +Backtrace/P +Backtracing/P +Bacula/P +Balancer/SP +Baref/SP +Baremetal/P +Baremetalhost/SP +Baseband/P +Baselineadminnetworkpolicy/SP +Basename/P +Batcher/P +Baz/P +Bcel/P +Bcrypt/P +Bcull/P +Bello/P +Bfa/P +Bfd/P +Bgp/P +Bierner/P +Bindable/P +Bindep/P +Bindtype/P +Binutil/SP +Bitbucket/P +Bitmask/P +Bitrate/SP +Bitwarden/P +Bitwise/P +Blackbox/P +Blkid/P +Blocklisted/P +Blocklisting/P +Blockmap/P +Bltk/P +Bluedevil/P +Bluetooth/P +Bluez/P +Bmap/P +Bmceventsubscription/SP +Bmh/SP +Bogo/P +Bonjour/P +Bookinfo/P +Bool/P +Boolean/P +Bootable/P +Bootc/P +Bootdev/P +Bootimage/SP +Bootkit/SP +Bootlist/P +Bootloader/P +Bootmap/P +Bootup/P +Bootupd/P +Borrowable/P +Bot/SP +Bottlenecked/P +Bpf/P +Bpfman/P +Bpftool/P +Bpftrace/P +Breakpoint/SP +Brltty/P +Broadcasted/P +Broadcom/P +Brun/P +Bsdcpio/P +Bsfm/P +Bsi/P +Bson/P +Bsonobjectid/P +Bstop/P +Btfr/SP +Btn/P +Btree/P +Btrfs/P +Buddyinfo/P +Bugfix/P +Bugzilla/P +Buildah/SP +Buildconfig/P +Buildhost/P +Buildpack/SP +Buildroot/P +Builtin/SP +Bundler/P +Burstable/P +Busybox/P +Bwidget/P +Byobu/P +Bz/SP +Bzr/P +CA/SP +CIDR/SP +CIL/P +CKAID/SP +CLB/SP +CLI/SP +CNF/SP +CNI/SP +CPU/SP +CR/SP +CRD/SP +CSP/SP +CSR/SP +CSV/SP +CUDN/SP +CVO/SP +Cachedir/P +Cachefilesd/P +Cachepool/P +Cacher/P +Cachevol/P +Caikit/P +Cainjector/P +Callout/SP +Camelcased/P +Canonicalization/P +Canonicalize/P +Canonicalized/P +Canonicalizing/P +Capturegroup/SP +Catalogd/P +Catalogsource/SP +Catchpoint/SP +Cavium/P +Ccis/SP +Ccoctl/P +Cdrom/P +Cdrskin/P +Cel/P +Ceph/P +Cephfs/P +Certf/SP +Certmonger/P +Certutil/P +Cflag/SP +Cgroup/SP +Chan/P +Changhua/P +Che-Theia/P +Che/P +Checkpointed/P +Checkpointing/P +Checkresult/SP +Checksu/P +Checksumming/P +Chipset/SP +Chkconfig/P +Chrony/P +Chronyd/P +Chroot/P +Chrooting/P +Chrt/P +Chunklimitsize/P +Ci/P +Cib/P +Cidr/SP +Ciphertext/SP +Civetweb/P +Clariion/P +Classful/P +Classload/SP +Classloaded/P +Classloader/P +Classloading/P +Classpath/P +Clearpart/P +Cleartext/P +Cli/SP +Clickjacking/P +Clientid/P +Clocksource/P +Cloudbursting/P +Cloudcredential/SP +Cloudformation/P +Cloudfront/P +Cloudian/P +Cloudprivateipconfig/SP +Cloudwashing/P +Cloudwatch/P +Clusterautoscaler/SP +Clustercatalog/SP +Clustercsidriver/SP +Clusterextension/SP +Clusterextensionrevision/SP +Clusterimagepolicy/SP +Clusterip/SP +Clusterlogforwarder/SP +Clusterlogging/SP +Clusteroperator/SP +Clusterresourcequota/SP +Clusterrole/SP +Clusterrolebinding/SP +Clusterserviceversion/SP +Clustertask/SP +Clustertriggerbinding/SP +Clusteruserdefinednetwork/SP +Clusterversion/SP +Cmd/SP +Cmdline/P +Cn/P +Cnic/P +Cnt/P +Cobertura/P +Codeblock/P +Codec/SP +Codemodel/P +Coderay/P +Codewind/P +Cohabitating/P +Colocate/P +Colocated/P +Colocating/P +Colocation/P +Columbiaville/P +Commandline/P +Compat/P +Composability/P +Composable/P +Composef/SP +Conditionalize/P +Conditionalized/P +Conditionalizing/P +Config/SP +Configmap/SP +Conformant/P +Conmon/SP +Connectionless/P +Connmark/P +Consoleclidownload/SP +Consoleexternalloglink/SP +Consolelink/SP +Consolenotification/SP +Consoleplugin/SP +Consolequickstart/SP +Consolesample/SP +Consoleyamlsample/SP +Container/SP +Containerd/P +Containerfile/SP +Containerruntime/SP +Containerruntimeconfig/SP +Controllerconfig/SP +Controlplanemachineset/SP +Cookiecutter/P +Cooldown/P +Coolkey/P +Coredumpctl/P +Corefile/P +Corequisite/P +Coreutil/SP +Corosync/P +Cosign/SP +Cpptest/P +Cppunit/P +Cpu/SP +Cpufreq/P +Cpuid/P +Cpupower/P +Cpuset/SP +Crashloopback/SP +Crashlooping/P +Createfile/P +Createrepo/P +Credentialsrequest/SP +Crio/P +Crl/SP +Cron/P +Cronjob/SP +Crontab/P +Crun/P +Crypto/P +Cryptoprocessor/P +Cryptsetup/P +Crypttab/P +Cs/P +Csi/P +Csisnapshotcontroller/SP +Cstate/P +Ctc/P +Ctdb/P +Ctrl/P +Cuda/P +Cui/P +Custodia/P +Customisable/P +Customizer/P +Cutover/P +Cv/P +Cvsp/SP +Cyber/P +Cyberattack/P +Cybercrime/P +Cybersecurity/P +Cyclictest/P +Cygmon/P +Cypher/SP +Cython/P +Czvf/P +DASD/SP +DB/SP +DC/SP +DIMM/SP +DLM/SP +DN/SP +DNF/P +DPA/SP +DPU/SP +DSO/SP +DU/SP +DV/SP +DVD/P +Daemon/P +Daemonless/P +Daemonset/SP +Dagre/P +Dalle/SP +Dammam/P +Dapl/P +Dasd/SP +Dasdfmt/P +Datacenter/SP +Dataclass/SP +Datadog/P +Datafile/P +Datagram/P +Dataimage/SP +Dataloader/SP +Datamover/P +Datapath/P +Datapoint/SP +Datasource/P +Datastore/SP +Datastream/P +Datatracker/P +Datavolume/P +Datestamped/P +Datetime/P +Dax/P +Dbu/SP +Dbx/P +Dconf/P +Deallocate/P +Deallocated/P +Deallocating/P +Deallocation/P +Deauthenticate/P +Deauthorize/P +Debugf/SP +Debuggability/P +Debuginfo/P +Debuglevel/P +Debugmode/P +Debugsource/P +Decapsulation/P +Declarative/P +Declaratively/P +Decompiler/P +Deconflict/P +Dedupe/P +Deduplicate/SP +Deduplicated/P +Deduplicating/P +Deduplication/P +Defragment/SP +Defragmentation/P +Defragmented/P +Defragmenting/P +Deis/P +Dejagnu/P +Deltaiso/P +Deltarpm/P +Demangling/P +Demodularized/P +Demouser/P +Dentry/SP +Denylist/P +Deploy/P +Deployer/SP +Deploymentconfig/SP +Depmod/P +Deprovision/P +Deprovisioned/P +Deprovisioning/P +Depsolve/P +Depsolving/P +Dequeue/SP +Dequeuing/P +Dereference/P +Dereferenced/P +Dereferencing/P +Deschedule/SP +Descheduled/P +Descheduler/P +Descheduling/P +Descriptor/P +Deserializable/P +Deserialization/P +Deserialize/SP +Deserialized/P +Deserializer/P +Deserializing/P +Destructor/SP +Desynchronization/P +Desynchronize/SP +Desynchronized/P +Desynchronizing/P +Dev/P +Devcatalog/P +Devfile/SP +Devicevolume/P +Devlink/SP +Devnode/P +Dex/P +Df/P +Dgst/P +Dhclient/P +Dhcp/P +Dhcpd/P +Dialog/SP +Dict/SP +Diffserv/P +Disallowment/P +Discoverability/P +Disklabel/SP +Diskless/P +Diskmaker/P +Diskspace/P +Diskspacecheck/P +Disruptable/P +Distinguisher/SP +Distro/SP +Django/P +Dmesg/P +Dmraid/P +Dn/SP +Dnf/P +Dnsmasq/P +Dnsrecord/SP +Dnstap/P +Docker/P +Dockerfile/SP +Docstore/P +Docstring/SP +Dogtag/P +Domainname/SP +Donut/P +Dosfstool/SP +Dotnet/P +Dovecot/P +Downloader/P +Downsampled/P +Downsampling/P +Downscaling/P +Downstream/SP +Downstreamed/P +Downstreaming/P +Downtime/SP +Dp/P +Dpdk/P +Dracut/P +Drilldown/P +Driverctl/P +Driverdisk/P +Driverless/P +Dropbox/P +Drpm/P +Drpmsync/P +Drupal/P +Dscp/P +Dst/P +Dstat/P +Dstrct/P +Dtdinst/P +Dualstack/P +Dumpet/P +Dumpxml/P +Dvd/P +Dvgrab/P +Dvice/SP +Dwarf/P +Dwarves/P +Dwz/P +Dx/P +Dymo/P +Dynatrace/P +Dyninst/P +EIP/SP +ELB/SP +ENI/SP +Easymock/P +Eb/SP +Ebpf/P +Ebtable/SP +Ecj/P +Editability/P +Efax/P +Efibootmgr/P +Egressfirewall/SP +Egressip/SP +Egressqos/SP +Egressrouter/SP +Egressservice/SP +Ei/P +Ekiga/P +Elasticloadbalancing/P +Elasticsearch/P +Elfutil/SP +Elink/SP +Emacs/P +Emptydir/P +Emulex/P +Enablegroup/SP +Enablement/P +Encoding/P +Endevor/P +Endian/P +Endif/P +Englightbox/P +Enlightbox/P +Enlightenment/SP +Enqueue/SP +Enqueued/P +Enricher/P +Entra/P +Enum/P +Env/SP +Eod/P +Eport/SP +Epydoc/P +Equinix/P +Errorlevel/P +Espeak/P +Esprima/P +Etcd/SP +Etcdctl/P +Etherchannel/P +Ethernet/P +Ethertype/P +Ethtool/P +Etype/P +Eu/SP +Eula/P +Eventing/P +Eventlistener/SP +Evmc/SP +Exactarchlist/P +Examplepath/P +Exbibyte/SP +Excludable/P +Excludelist/P +Exe/P +Exec/P +Execstack/P +Exif/P +Existingfile/P +Expander/SP +Expectk/P +Expiration/P +Exposable/P +Exposal/P +Expr/P +Externalname/P +Extlinux/P +Extranet/P +Extrapartition/P +FIFO/P +FIP/SP +FPGA/SP +FQDN/SP +Fabrice/P +Faceplate/SP +Facter/P +Factory/SP +Fadump/P +Failback/P +Failover/P +Failsafe/P +Fakeroot/P +Fapolicy/P +Fapolicyd/P +Farstream/P +Fastpath/P +Favicon/SP +Fc/P +Fcntl/P +Fcoe/P +Fcull/P +Fdasd/P +Fdatasync/P +Fdisk/P +Featuregate/SP +Featureset/P +Fedc/P +Fedcb/P +Fernflower/P +Fielddata/P +Fieldset/SP +Filebench/P +Fileio/P +Filelist/P +Filelog/P +Filepath/SP +Filesaving/P +Fileshare/P +Filestore/P +Filesystem/SP +Finalizer/SP +Findability/P +Finetune/SP +Finetuned/P +Finetuner/P +Finetuning/P +Fio/P +Fip/SP +Firefox/P +Firewalld/P +Firewalling/P +Firmware/SP +Firmwareschema/SP +Firstboot/P +Firstimage/P +Flamegraph/SP +Flathub/P +Flatpak/P +Flexran/P +Flocker/P +Flowlog/SP +Flowtable/SP +Fluentd/SP +Flushinterval/P +Flushmode/P +Flushthreadcount/P +Flyway/P +Fonttool/SP +Footnoteref/P +Fortran/P +Fortville/P +Freedesktop/P +Freerdp/P +Fro/SP +Fromon/P +Fromui/P +Fronthaul/P +Frr/P +Frun/P +Fsck/P +Fsf/P +Fsid/P +Fstab/P +Fstop/P +Fstrm/P +Fstype/P +Fsync/P +Ftrace/P +Fulcio/P +Fullname/P +Fullpack/P +Func/P +Funqy/P +Fuseiso/P +Futex/P +GCC/P +GID/P +GPO/SP +GPU/SP +GTID/SP +GUI/P +GVK/SP +Galera/P +Gatewayclass/SP +Gaudi/P +Gbps/P +Gc/P +Gcab/P +Gcc/P +Gce/P +Gcloud/P +Gcloudcompute/P +Gcp/P +Gdb/P +Gdbm/P +Gdm/P +Gedit/P +Gemalto/P +GenAI/P +Genai/P +Geneve/P +Genpkey/P +Geo/P +Geoclue/P +Geospatial/P +Gerrit/P +Gestetner/P +Getdent/P +Getsubid/P +Ghislain/P +Ghostscript/P +Gibibyte/SP +Giesecke/P +Giga/P +Gitea/P +Github/P +Gitlab/P +Gitop/SP +Glew/P +Glibc/P +Glock/SP +Glstat/SP +Gluster/P +Glusterfs/P +Gmp/P +Gnote/P +Godebug/P +Godoc/P +Gofmt/P +Gog/SP +Golang/SP +Goroutine/SP +Govc/P +Gperftool/SP +Gpgcakey/P +Gpgcheck/P +Gpgkey/P +Gpsd/P +Gpspipe/P +Gpt/P +Gradle/P +Grafana/SP +Grafea/SP +Grantlee/P +Granularity/SP +Graylog/P +Grayscale/P +Greenboot/P +Gregor/P +Groupofname/SP +Grouprestriction/SP +Growpart/P +Grpc/P +Gsetting/SP +Gssntlmssp/P +Gstreamer/P +Gsutil/P +Gtk/P +Gucharmap/P +Guestf/SP +Gutenprint/P +Gvncpulse/P +Gw/P +Gwenview/P +Gz/P +Gzip/P +Gzipped/P +HBA/SP +HCA/SP +HCP/SP +HDD/SP +HPA/SP +HSM/SP +HT/SP +HTTP/SP +Hadamard/P +Hamcrest/P +Hamina/P +Hardcode/P +Hardcoded/P +Hardcoding/P +Harddrive/P +Hardlink/SP +Hardlockup/P +Hardwaredata/P +Hashbang/SP +Hashicorp/P +Hashmap/P +Hawkey/P +Hawkular/P +Hcp/SP +Healthcheck/P +Healthz/P +Heapster/P +Heatmap/SP +Helgrind/P +Helm/P +Helmchartrepository/SP +Helpdesk/P +Heredoc/SP +Heterogeneous/P +Hexchat/P +Hexcolor/SP +Hextet/SP +Highport/P +Hipaa/P +Hiper/SP +Hipersocket/SP +Hitm/P +Hivex/P +Hmaccalc/P +Hmc/P +Hoc/P +Homebrew/P +Hookpoint/SP +Hostapd/P +Hostcluster/SP +Hostfile/P +Hostfirmwarecomponent/SP +Hostfirmwaresetting/SP +Hostgroup/SP +Hostname/SP +Hostpath/P +Hostupdatepolicy/SP +Hostwithnatswitch/P +Hotfix/SP +Hotplug/P +Hotspot/SP +Hpij/SP +Hplip/P +Hpsa/P +Hptiop/P +Href/P +Hsakmt/P +Hsqldb/P +Htdig/P +Html/P +Htmltest/P +Htpasswd/P +Http/SP +Httpd/P +Httproute/SP +Hugepage/SP +Hunyuan/P +Hwlatdetect/P +Hyperconverged/P +Hyperdisk/P +Hyperscale/P +Hyperscaler/P +Hypershift/P +Hyperthreading/P +ICSP/SP +IDE/P +IDP/SP +IFL/SP +IME/SP +IO/SP +IOCTL/SP +IOP/SP +IP/SP +IPA/P +IPI/SP +IQN/SP +IRQ/SP +IRTT/SP +ISO/SP +ISP/SP +Iamserviceaccount/SP +Ibmcloud/P +Ibmcos/P +Iburst/P +Ibutil/SP +Icsp/SP +Idempotence/P +Idm/P +Idmap/P +Idmclient/P +Idmgroup/P +Idmserver/P +Idmuser/P +Idoverridegroup/P +Idoverrideuser/P +Idp/SP +Idview/P +Ifcfg/P +Ifconfig/P +Ifdef/P +Ifeval/P +Ifndef/P +Ignoredisk/P +Ilo/P +Imagedigestmirrorset/SP +Imagepolicy/SP +Imageregistry/P +Imageset/P +Imagestream/SP +Imagestreamimage/SP +Imagestreamtag/SP +Imagetagmirrorset/SP +Imake/P +Img/P +Immediate/P +Impactful/P +Implementor/P +Imsetting/SP +Includepkg/SP +Incore/P +Inetorgperson/P +Inetuser/P +Inference/SP +Inferenced/P +Inferencing/P +Inferentia/P +Infiniband/P +Infinispan/P +Infoblox/P +Infotec/P +Ing/P +Ingester/SP +Ingresscontroller/SP +Ingressgateway/SP +Ini/SP +Iniparser/P +Initialism/SP +Initializer/SP +Initio/P +Initramf/SP +Initrd/P +Initscript/SP +Inline/SP +Inlined/P +Inlining/P +Inode/P +Inplace/P +Installonlypkg/SP +Installplan/SP +Installrootkeep/P +Instancetype/P +Instantiator/SP +Instruction/SP +Instrumentation/SP +Intel/P +Intelephense/P +Intellij/P +Interdomain/P +Interoperate/P +Interoperating/P +Intersight/P +Interzone/P +Intracluster/P +Intranode/P +Intrapartition/P +Intrarecord/P +Intraservice/P +Intrasystem/P +Intrazone/P +Invalidation/SP +Invocable/P +Iok/P +Iopen/P +Iostat/P +Ip/SP +Ipa/P +Ipaclient/SP +Ipactl/P +Ipaddres/SP +Ipaddress/SP +Ipaddressclaim/SP +Ipadnsconfig/P +Ipagroup/P +Ipahost/P +Ipaidp/P +Ipam/P +Ipaobject/P +Ipaserver/P +Ipasshuser/P +Ipausergroup/P +Ipc/P +Ipfix/P +Ipi/SP +Ipmievd/P +Ipmitool/P +Ippool/SP +Iproute/P +Ipsec/P +Ipsilon/P +Ipsum/P +Iptable/SP +Iputil/SP +Ipvlan/P +Iqn/SP +Irdma/P +Irq/SP +Irqbalance/P +Irqsoff/P +Irreproducibility/P +Irssi/P +Isbn/P +Isci/P +Iscsi/P +Iscsiadm/P +Iscsiname/P +Iso/SP +Isorelax/P +Iss/P +Istio/SP +Istioctl/P +Istiod/SP +Itanium/P +JDK/SP +JRE/SP +JVM/P +JWT/SP +Jabberpy/P +Jackson/P +Jaeger/SP +Jaf/P +Jakarta/P +Jandex/P +Jarjar/P +Java/P +Javac/P +Javamail/P +Javascript/P +Jaxen/P +Jbigkit/P +Jboss/P +Jctool/SP +Jdata/P +Jdom/P +Jemalloc/P +Jenkinsfile/P +Jigawatt/SP +Jing/P +Jira/P +Jmc/P +Jna/P +Joesec/P +Jolokia/P +Journal/SP +Journalctl/P +Journald/P +Journaled/P +Journaling/P +Journalling/P +Joyent/P +Jq/P +Jruby/P +Js/P +Jsmith/P +Json/P +Juk/P +Junit/P +Jurong/P +Jvm/P +KDC/SP +KPI/SP +KRA/SP +KVM/P +Kaccessible/P +Kactivitie/SP +Kafka/P +Kamera/P +Kaniko/P +Kata/P +Kate/P +Katello/P +Kbase/P +Kbd/P +Kbyte/SP +Kcalc/P +Kcharselect/P +Kcolorchooser/P +Kcoloredit/P +Kdeaccessibility/P +Kdeadmin/P +Kdeartwork/P +Kdegraphic/SP +Kdelib/SP +Kdemultimedia/P +Kdenetwork/P +Kdepim/P +Kdepimlib/SP +Kdesdk/P +Kdeutil/SP +Kdf/P +Kdump/P +Keda/P +Keepalive/P +Keepalived/P +Keepcache/P +Kepler/P +Kerberize/P +Kerberized/P +Kerberos/P +Kernelpkgname/SP +Kernelshark/P +Kexec/P +Keycloak/SP +Keyfile/SP +Keyless/P +Keylime/P +Keymap/SP +Keypair/SP +Keyphrase/P +Keyring/SP +Keyserver/P +Keyslot/P +Keyspace/P +Keystore/P +Keytab/SP +Kgamma/P +Kgpg/P +Khotkey/SP +Kiali/P +Kibana/P +Kibibyte/SP +Kickstart/SP +Kiconedit/P +Kinesi/SP +Kinfocenter/P +Kinit/P +Klist/P +Klog/P +Klusterlet/P +Kmag/P +Kmenuedit/P +Kmix/P +Kmod/SP +Knative/P +Knet/P +Knowledgebase/P +Kogito/P +Kolourpaint/P +Kompose/P +Konflux/P +Konkretcmpi/P +Konnectivity/P +Konsole/P +Kopia/P +Kourier/P +Kpatch/P +Kprobe/SP +Krbprincipalaux/P +Krbticketpolicyaux/P +Krew/P +Kronosnet/P +Kruler/P +Ksaneplugin/P +Kscreen/P +Ksdevice/P +Ksmd/P +Ksnapshot/P +Ksonnet/P +Ksshaskpas/SP +Ksysguard/P +Ksysguardd/P +Ktimer/P +Kube/P +Kubeadmin/P +Kubebuilder/P +Kubeconfig/P +Kubectl/P +Kubedns/P +Kubelet/SP +Kubeletconfig/P +Kubeproxy/P +Kubernetes/P +Kubernetesenv/P +Kubespray/P +Kubevirt/P +Kueue/SP +Kustomization/P +Kustomize/P +Kvm/P +Kwallet/P +Kwin/P +Kwrite/P +Kxml/P +Kylin/P +Kyocera/P +LAN/SP +LBN/SP +LCU/SP +LLM/SP +LPAR/SP +LUN/SP +LV/SP +Langpack/SP +Lanier/P +Laravel/P +Latencytop/P +Latrace/P +Layernorm/P +Lc/P +Ld/P +Ldap/P +Ldapmodify/P +Ldapsearch/P +Ldconfig/P +Ldns/P +Leapp/P +Lenovo/P +Leptonica/P +Leveloffset/SP +Lexmark/P +Lftp/P +Libaio/P +Libappindicator/P +Libbabeltrace/P +Libbluedevil/P +Libbonobo/P +Libbonoboui/P +Libbpf/P +Libc/P +Libchewing/P +Libcmpiutil/P +Libcrypto/P +Libdb/P +Libdbi/P +Libdnf/P +Libecpg/P +Libee/P +Libesmtp/P +Libfdt/P +Libg/SP +Libgccjit/P +Libgcrypt/P +Libgepub/P +Libgnat/P +Libgnome/P +Libgnomecanvas/P +Libgnomeui/P +Libgo/P +Libgudev/P +Libguestf/SP +Libgxim/P +Libhangu/P +Libhif/P +Libibcommon/P +Libibmad/P +Libica/P +Libidn/P +Libij/SP +Libindicator/P +Libinput/P +Libiodbc/P +Libiscsi/P +Libkcddb/P +Libkcompactdisc/P +Libkdcraw/P +Libkipi/P +Libkkc/P +Libksane/P +Libkscreen/P +Libkworkspace/P +Liblockfile/P +Libmemcached/P +Libmodulemd/P +Libmsn/P +Libmudflap/P +Libmusicbrainz/P +Libmx/P +Libnbd/P +Libnetapi/P +Libnice/P +Libnl/P +Libnma/P +Libnmstate/P +Libnsl/P +Libntlm/P +Libnumbertext/P +Libobjc/P +Libofa/P +Liboil/P +Libomp/P +Libpgtype/SP +Libpinyin/P +Libpmemcto/P +Libpod/P +Libpq/P +Libpst/P +Libpwquality/P +Librados/P +Librbd/P +Libreoffice/P +Libreswan/P +Librt/P +Librtk/P +Librtkaio/P +Libsecret/P +Libsexy/P +Libslirp/P +Libssh/P +Libssl/P +Libtpm/SP +Libtraceevent/P +Libtracef/SP +Libtranslit/P +Libunwind/P +Liburing/P +Libvirt/P +Libvirtd/P +Libwbclient/P +Libwinpr/P +Libwpe/P +Libwvstream/SP +Libxcrypt/P +Libxdp/P +Libxmlb/P +Libzapojit/P +Libzhuyin/P +Libzstd/P +Licensor/P +Lifecycled/P +Lightbox/P +Lightspeed/P +Linearization/P +Linearize/P +Linux/P +Linuxptp/P +Liquibase/P +Liveimg/P +Liveness/P +Lld/P +Lldb/P +Llvm/P +Lmdb/P +Lmod/P +Loadbalancer/SP +Loadbalancing/P +Localnet/P +Localssd/P +Lockdown/SP +Lockfile/P +Lockless/P +Lockspace/P +Logcollector/P +Logfile/P +Logicalvolume/SP +Loginuid/P +Loglevel/P +Logrotate/P +Logstash/P +Logvol/P +Loki/P +Lokistack/P +Lombok/P +Lookaside/P +Lookback/P +Lookup/SP +Loopback/P +Lorax/P +Lowercase/SP +Lowercased/P +Lpadmin/P +Lpar/SP +Lpfc/P +Lrecl/P +Lshw/P +Lsname/P +Lstopo/P +Ltrace/P +Lua/P +Lucene/P +Luk/SP +Luksmeta/P +Lun/SP +Lvm/P +MB/SP +MCP/SP +MSA/SP +MSR/SP +MTA/SP +MTU/SP +Machineautoscaler/SP +Machinehealthcheck/SP +Machineosconfig/SP +Machinepool/SP +Machineset/SP +Macrostructure/P +Macvlan/P +Macvtap/P +Madvise/P +Mainboard/P +Maistra/P +Makedumpfile/P +Makefile/SP +Manpage/P +Mariabackup/P +Maskable/P +Matcher/SP +Matchrule/P +Matrixes/P +Matrox/P +Mattermost/P +Maven/P +Maxpoll/P +Mbit/P +Mbp/SP +Mcollective/P +Md/P +Mdadm/P +Mddownloadpolicy/P +Mdev/P +Mdevctl/P +Mdpolicy/P +Mebibytes/P +Mechdyne/P +Mediacheck/P +Mellanox/P +Memberlist/P +Membermanager/P +Memcache/P +Memcg/P +Memcheck/P +Memnode/P +Memstick/P +Memstomp/P +Memstrack/P +Mergeable/P +Metacharacter/SP +Metaclass/P +Metafile/P +Metalink/P +Metallb/P +Metamodel/P +Metapackage/P +Metatable/P +Mgetty/P +Mgmt/P +Mib/P +Microarchitectural/P +Microarchitecture/SP +Microdnf/P +Micropipenv/P +Microsegmentation/P +Microservice/SP +Microsoft/P +Middleware/P +Midhaul/P +Miganalytic/P +Migplan/P +Migr/P +Migratable/P +Migrationtool/SP +Migstorage/P +Miimon/P +Millicore/SP +Millicpu/P +Mimetype/P +Min/P +Minicourse/P +Minicpm/P +Minidisk/P +Minikube/P +Minimalistic/P +Minio/P +Minishift/P +Minizip/P +Minpoll/P +Minrate/P +Mirantis/P +Mirrorlist/P +Misconfiguration/SP +Misconfigured/P +Misconfiguring/P +Mitigation/SP +Mixin/SP +Mixtral/P +Mkbootdisk/P +Mkf/SP +Mkinitrd/P +Mmc/P +Mng/P +Mntpoint/P +Mockito/P +Modesetting/P +Modrdn/P +Modularization/P +Modularize/P +Modulefile/SP +Mokutil/P +Monck/SP +Monorepo/SP +Monospace/P +Monospaced/P +Monthday/SP +Mountd/P +Mountpoint/SP +Mountstat/SP +Mpage/P +Mpdecimal/P +Mpich/P +Mpirun/P +Mpp/SP +Mptbase/P +Mptcpd/P +Mptcpize/P +Mptctl/P +Mptsa/SP +Mptscsih/P +Mptspi/P +Msbuild/P +Msdo/SP +Msg/P +Mssql/P +Mthca/P +Mtime/P +Mtl/SP +Mtu/SP +Multiarch/P +Multibyte/P +Multicast/P +Multicloud/P +Multicluster/P +Multicontainer/P +Multifactor/P +Multihoming/P +Multihop/P +Multihost/P +Multilib/P +Multiline/P +Multimesh/P +Multimodal/P +Multinamespace/P +Multinode/P +Multipath/P +Multipathed/P +Multipathing/P +Multipoint/P +Multiport/P +Multiprogram/P +Multiprotocol/P +Multiqueue/P +Multischema/P +Multisite/P +Multitable/P +Multitenancy/P +Multitenant/P +Multithread/P +Multithreading/P +Multitier/P +Multitiered/P +Multiuser/P +Multivendor/P +Multizone/P +Multu/SP +Mutex/SP +Mvsa/SP +Mvumi/P +Myapp/P +Mydestination/P +Mydomain/P +Myecho/P +Mylv/P +Mynetwork/SP +Myproject/P +Myricom/P +Mysql/P +Mysqldump/P +Mythinsnap/P +Myubi/P +Myvdo/P +Myvg/P +NAD/SP +NAT/SP +NDN/SP +NF/SP +NIC/SP +NLB/SP +NMI/SP +NNCP/SP +NPU/SP +NUMA/SP +NVDIMM/SP +Na/P +Nagios/P +Nagle/P +Nameserver/SP +Namespace/SP +Namespaced/P +Namespacing/P +Nano/SP +Narayana/P +Nasm/P +Nbctl/P +Nbdb/P +Nbdfuse/P +Ndctl/P +Nehalem/P +Nekohtml/P +Neoverse/P +Nestedgroup/P +Netavark/P +Netboot/P +Netcf/P +Netclass/SP +Netconsole/P +Netdev/P +Netdevice/P +Netfilter/P +Netgroup/SP +Netlify/P +Netlink/P +Netmask/P +Netobserv/P +Netronome/P +Netty/P +Netware/P +Newdisk/P +Newdoc/P +Newecho/P +Newrdn/P +Nf/SP +Nfp/P +Nfsnobody/P +Nfsometer/P +Nfstest/P +Nftable/SP +Nginx/P +Nic/SP +Nicpf/P +Nicvf/P +Ningxia/P +Nispor/P +Nlb/SP +Nlt/P +Nm/P +Nmap/P +Nmcli/P +Nmstate/P +Nmstatectl/P +Nmtui/P +Noarch/P +Nodeagent/P +Nodejs/P +Nodename/SP +Nodeport/P +Nodeselector/SP +Nodesliceippool/SP +Nodeslicepool/SP +Noexec/P +Nohotcorner/P +Nohz/P +Nonauthoritative/P +Nondefault/P +Nondestruct/P +Nonencrypted/P +Nonexpiring/P +Nonheap/P +Noninteractive/P +Nonlocal/P +Nonmaskable/P +Nonoverlapping/P +Nonpaired/P +Nonposix/P +Nonrecovery/P +Nonrecursive/P +Nonrenewal/P +Nonroot/P +Nonsystem/P +Nooba/P +Noobaa/P +Nop/P +Normalspoke/P +Northd/P +Nosmt/P +Nosniff/P +Notchecked/P +Novell/P +Npm/P +Npth/P +Nsenter/P +Nslcd/P +Nsswitch/P +Nsupdate/P +Nt/P +Ntfs/P +Ntlm/P +Ntlmssp/P +Ntp/P +Ntpd/P +Ntpdate/P +Ntpdc/P +Ntpq/P +Ntpstat/P +Num/P +Numactl/P +Numaresourcesoperator/SP +Numastat/P +Numatop/P +Numpy/P +Nutanix/P +Nuxwdog/P +Nvdimm/SP +Nvidia/P +Nvme/P +Nvmetcli/P +OCI/P +OCPU/SP +OEM/SP +OID/SP +OLM/SP +OS/SP +OSD/SP +OTP/SP +OU/SP +OV/SP +Oauth/P +Oauthaccesstoken/SP +Oauthauthorizetoken/SP +Oauthclient/SP +Obexd/P +Oc/P +Ocaml/P +Oci/P +Ocm/P +Ocp/P +Ocsp/P +Octeon/P +Odc/P +Odo/P +Offboard/SP +Offboarded/P +Offboarding/P +Offlined/P +Offlining/P +Oidc/P +Oki/P +Okindf/P +Okta/P +Okular/P +Ollama/P +Olm/SP +Olmconfig/SP +Omnichannel/P +Omnikey/P +Onboard/SP +Onboarded/P +Onboarding/P +Oneshot/P +Onlining/P +Opae/P +Opencc/P +Opencv/P +Openflow/P +Openid/P +Openjade/P +Openjpeg/P +Openlmi/P +Openmpi/P +Openobex/P +Opensc/P +Openscap/P +Openshiftapiserver/SP +Openshiftcontrollermanager/SP +Opensp/P +Openssl/P +Openstack/SP +Openvswitch/P +Oper/P +Operand/SP +Operator/P +Operatorcondition/SP +Operatorgroup/SP +Operatorpki/SP +Oplock/P +Opm/P +Oprofile/P +Opteron/P +Optipng/P +Organizationalperson/P +Ortp/P +Osad/P +Osasco/P +Osbuild/P +Osd/SP +Oslat/P +Osname/P +Ospp/P +Ossm/P +Osst/P +Ostoy/P +Ostree/P +Ostreecontainer/P +Ostreesetup/P +Otlp/P +Outfile/P +Overcommit/P +Overcommitted/P +Overcommitting/P +Overflowaction/P +Overlappingrangeipreservation/SP +Overlayf/SP +Overprovisioned/P +Overprovisioning/P +Overridable/P +Overriden/P +Overstrike/P +Overutilized/P +Overvoting/P +Overwritable/P +Ovirt/P +Ovis/P +Ovmf/P +Ovn/P +Oxmox/P +PAM/SP +PBN/SP +PCR/SP +PD/SP +PDB/SP +PDF/SP +PDMA/SP +PF/SP +PHC/SP +PHP/P +PMDA/SP +PNA/SP +PNF/SP +PPK/SP +PSAT/SP +PSK/SP +PTE/SP +PUK/SP +PV/SP +Packagemanifest/P +Packageserver/P +Pagecache/P +Pagerduty/P +Pagure/P +Pak/SP +Papi/P +Parallelization/P +Param/SP +Parameterization/P +Parameterizing/P +Paravirtual/P +Paravirtualization/P +Paravirtualized/P +Parksmap/P +Parm/P +Parsable/P +Parseable/P +Passdb/P +Passivetex/P +Passt/P +Passthrough/P +Passwd/P +Passwordless/P +Pata/P +Pathgroup/P +Pathing/P +Pathname/SP +Patternfly/P +Paulo/P +Pc/P +Pcm/P +Pcp/P +Pcre/P +Pcsd/P +Pebibyte/SP +Pello/P +Pensando/P +Perc/P +Perf/P +Performanceprofile/SP +Performant/P +Perl/P +Perltidy/P +Persistdir/P +Persistentvolumeclaim/SP +Petitboot/P +Pexpect/P +Pgaudit/P +Php/P +Pid/P +Pingable/P +Pinnedimageset/SP +Pipelined/P +Pipelinerun/SP +Pipelining/P +Pixmap/SP +Pixtral/P +Pkc/SP +Pkey/P +Pkgconfig/P +Pkinit/P +Plaintext/P +Pluggable/P +Pluginconfpath/P +Pluginpath/P +Pmc/P +Pmcd/P +Pmchart/P +Pmcraid/P +Pmem/P +Pminfo/P +Pmlogconf/P +Pmlogger/P +Pmproxy/P +Pmrep/P +Pmserie/SP +Pmstore/P +Pngcrush/P +Pngnq/P +Po/P +Poddisruptionbudget/SP +Podified/P +Podman/P +Podmonitor/SP +Podnetworkconnectivitycheck/SP +Polkit/P +Polling/SP +Polyinstantiated/P +Polyinstantiation/P +Poppler/P +Populator/SP +Portforward/P +Portgroup/P +Portmapper/P +Portworx/P +Posix/P +Postedit/SP +Postedited/P +Postediting/P +Posteditor/P +Postgre/SP +Postgresql/P +Postinstall/P +Postinstallation/P +Postoperation/P +Postprocessing/P +Postqueue/P +Postrequisite/P +Poweroff/P +Powerpath/P +Powersave/P +Powersaving/P +Powershell/P +Powertop/P +Powervs/P +Ppd/SP +Pprof/P +Pragma/P +Pre/P +Preallocate/SP +Preallocated/P +Preallocating/P +Preallocation/P +Preauthentication/P +Preboot/P +Prebuild/P +Precache/SP +Precached/P +Precaching/P +Precheck/SP +Precompile/SP +Precompiled/P +Precompute/P +Precomputing/P +Preconfiguration/P +Preconfigure/SP +Preconfigured/P +Preconfiguring/P +Preconnect/SP +Precreate/P +Preemptible/P +Preemption/SP +Preemptirqsoff/P +Preemptoff/P +Preenrollment/P +Prefetch/P +Prefill/P +Prefork/P +Preformat/SP +Preformatted/P +Preformatting/P +Pregenerate/SP +Pregenerated/P +Pregenerating/P +Pregeneration/P +Preinstall/P +Preinstallation/P +Preinstalling/P +Prelink/P +Preload/P +Preloaded/P +Preloading/P +Preoperational/P +Prepend/SP +Prepended/P +Prepending/P +Prepopulate/P +Prepopulated/P +Preprocess/P +Preprocessor/P +Preprovisioning/P +Preprovisioningimage/SP +Prereq/P +Prerequired/P +Prerollback/P +Preruntime/P +Presigned/P +Pretrained/P +Preupgrade/P +Printk/P +Prioritizer/SP +Priorityclass/SP +Privatelink/P +Prober/SP +Productization/P +Productize/SP +Productized/P +Productizing/P +Productpage/P +Profileparser/P +Profiler/P +Projecthelmchartrepository/SP +Prometheus/P +Prometheusrule/SP +Promql/P +Promtail/P +Protobuf/P +Provisionator/P +Provisioner/SP +Proxied/P +Proxying/P +Proxyless/P +Psample/P +Pscsi/P +Pseudocode/P +Pseudorandom/P +Pseudotext/P +Psql/P +Psutil/SP +Pth/P +Pthread/SP +Ptlib/P +Pulldown/P +Pullspec/P +Pullthrough/P +Pushpull/P +Pvc/P +Pvck/P +Pvcreate/P +Pvpanic/P +Pxelinux/P +QAT/SP +Qatengine/P +Qatlib/P +Qatzip/P +Qdisc/SP +Qdmanage/P +Qdox/P +Qdstat/P +Qeth/P +Qimageblitz/P +Qjson/P +Qlcnic/P +Qlge/P +Qlogic/P +Qnetd/P +Qos/P +Quadlet/SP +Quadro/P +Quantizable/P +Quantization/P +Quantize/SP +Quantized/P +Quantizer/P +Quantizing/P +Quarkiverse/P +Quarkus/P +Querier/P +Queryable/P +Querylog/P +Quickstart/SP +Quiescing/P +Quiltflower/P +Quobyte/P +Quotacheck/P +Quotasync/P +Qute/P +Qwen/P +Qxl/P +RA/SP +RBAC/SP +RCODE/SP +RDBMS/SP +RHEL/P +RPC/SP +RPZ/SP +RSCN/SP +RTT/SP +RU/SP +RUV/SP +RWN/SP +Racadm/P +Radeon/P +Rado/SP +Radvd/P +Raleigh/P +Ramdisk/P +Rangeallocation/SP +Rangesize/P +Rasdaemon/P +Rase/P +Rawip/P +Rbac/SP +Rbd/P +Rc/P +Rd/P +Rdate/P +Rdist/P +Reachability/P +Reactively/P +Readahead/P +Readlinelimit/P +Readonly/P +Realmd/P +Realtime/P +Reauthenticate/SP +Reauthenticated/P +Reauthenticating/P +Reauthentication/P +Rebalance/SP +Rebalanced/P +Rebalancer/P +Rebalancing/P +Rebase/SP +Rebased/P +Rebasing/P +Recertification/SP +Rechunk/P +Rechunking/P +Recommender/SP +Reconciler/SP +Recordset/P +Recursing/P +Recursor/SP +Redcircle/P +Redeployment/SP +Redi/SP +Redirection/SP +Redirector/SP +Redistributable/P +Redistributions/P +Reenable/SP +Reenabled/P +Reenabling/P +Reencrypt/P +Reencrypted/P +Reencrypting/P +Reenlightenment/P +Reentrant/P +Referenceable/P +Referencegrant/SP +Reflink/P +Reflinked/P +Reformat/SP +Refreshable/P +Regedit/P +Regionalized/P +Reimage/P +Reimaging/P +Reimplementation/P +Reindex/SP +Reindexed/P +Reindexer/P +Reindexing/P +Reinitialization/P +Reinitialize/SP +Reinitializing/P +Reinstall/SP +Reinstallation/P +Rekey/P +Rekeyed/P +Rekeying/P +Rekor/P +Relabeling/SP +Relaxngcc/P +Releasever/P +Reloadable/P +Relocation/SP +Remediation/SP +Remediator/P +Remirror/P +Remirroring/P +Remotebaud/P +Remoting/P +Remountable/P +Renderedmachineconfig/SP +Replaceable/SP +Replicaset/SP +Repo/SP +Repodata/P +Repositoryid/P +Reposync/P +Reprovision/P +Reprovisioned/P +Reprovisioning/P +Repurpose/P +Reqpart/P +Requestor/P +Requeue/SP +Requeued/P +Reranker/P +Rescan/P +Rescanning/P +Resctl/P +Reshard/SP +Resharded/P +Resharder/P +Resharding/P +Resizable/P +Resizeable/P +Resizef/SP +Resizer/P +Resnet/P +Resourcegroupstaggingapi/P +Responder/SP +Resteasy/P +Restic/P +Restorecon/P +Resultserver/P +Resync/SP +Resynced/P +Resyncing/P +Retrigger/P +Retrymaxinterval/P +Retrytimeout/P +Retrytype/P +Retrywait/P +Reusability/P +Revisioned/P +Rfc/P +Rfkill/P +Rgb/P +Rgbcolor/P +Rgrp/P +Rh/P +Rhc/P +Rhcd/P +Rhdh/P +Rhel/P +Rhev/P +Rhncfg/P +Rhnpush/P +Rhscl/P +Rhsm/P +Ricoh/P +Rkt/P +Rmt/P +Rngom/P +Ro/P +Rockhopper/P +Rolebinding/SP +Rolebindingrestriction/SP +Rollout/SP +Rollup/SP +Rootf/SP +Rootful/P +Rootless/P +Rootpw/P +Rosa/P +Roundrobin/P +Roundtable/SP +Routable/P +Routing/SP +Rpc/SP +Rpcbind/P +Rpcclient/P +Rpcgen/P +Rpm/SP +Rpmnew/P +Rpmsave/P +Rpmverbosity/P +Rsh/P +Rshared/P +Rshim/P +Rsize/P +Rslave/P +Rsync/P +Rsyslog/P +Rtcdata/P +Rtcheck/P +Rtctl/P +Rteval/P +Rtla/P +Rubygem/SP +Rulebook/P +Ruleset/P +Runbook/SP +Runc/P +Runcmd/P +Runlabel/SP +Runlevel/SP +Runpath/P +Runtime/SP +Ruser/SP +Rustfmt/P +Rw/P +Rwho/P +Rwx/P +Rwxrwxrwx/P +Rx/P +SA/SP +SCC/SP +SCM/P +SCP/SP +SDK/SP +SHA/SP +SID/SP +SKU/SP +SLO/SP +SMCP/SP +SME/SP +SMI/SP +SNI/SP +SPN/SP +SRE/SP +SSD/SP +SSH/SP +SSSD/P +SVG/P +SVID/SP +Sadc/P +Sadump/P +Safetensor/SP +Sakila/P +Sameorigin/P +Samepage/P +Sandboxed/P +Sandboxing/P +Sanlock/P +Sapconf/P +Sar/P +Satisfiability/P +Savin/P +Saxon/P +Sbc/P +Sbd/P +Sbt/P +Sca/P +Scaffolded/P +Scaffolder/P +Scaledown/P +Scaler/SP +Scalprum/P +Scannotation/P +Scap/P +Scatterchart/P +Sched/P +Schedulability/P +Schedulable/P +Scheduler/P +Scipy/P +Scon/SP +Scpio/P +Scriptable/P +Scriptlet/SP +Scrollbar/P +Scsi/P +Sctp/P +Sda/P +Sdk/SP +Sdparm/P +Seagate/P +Searchability/P +Searchguard/P +Seccomp/P +Secureboot/P +Securitycontextconstraint/SP +Sed/P +Selinux/P +Semanage/P +Semeru/P +Semver/P +Senao/P +Sendmail/P +Sensu/P +Serializable/P +Serialization/P +Serializer/P +Serverless/P +Serviceaccount/SP +Serviceaccountrestriction/SP +Servicemonitor/SP +Servicequota/P +Servlet/P +Setgid/P +Setter/P +Setuid/P +Setuptool/P +Sevctl/P +Sfc/P +Sftp/P +Sgabio/SP +Sgc/P +Shadowman/P +Shard/SP +Sharded/P +Sharding/P +Shotwell/P +Showback/P +Showdupesfromrepo/SP +Shows/P +Shufflesharding/P +Sid/SP +Sidecarless/P +Sideload/P +Sideloaded/P +Sigstore/P +Silicom/P +Sindhu/P +Sinked/P +Sisu/P +Siw/P +Skipx/P +Skopeo/P +Skyhawk/P +Skylake/P +Sla/P +Slirp/P +Slurm/P +Sm/P +Smartcard/P +Smarthost/P +Smb/P +Smbcacl/SP +Smbclient/P +Smbcontrol/P +Smbpasswd/P +Smbstatus/P +Smbtar/P +Smoothquant/P +Smp/P +Smtp/P +Sn/P +Snactor/P +Snakeyaml/P +Snapset/P +Snapshotted/P +Snapshotter/P +Snapshotting/P +Sntp/P +Snyk/P +So/P +Softdog/P +Softlockup/P +Software/SP +Solarflare/P +Solaris/P +Somelibrary/P +Soname/P +Sonataflow/P +Sonatype/P +Sorce/P +Sosreport/SP +Sourcestat/SP +Sourcetype/SP +Sox/P +Spacebar/P +Spamc/P +Spamd/P +Spanmetric/SP +Sparsification/P +Sparsified/P +Sparsify/SP +Sparsifying/P +Speex/P +Speexdsp/P +Spindown/P +Spinlock/SP +Splitscreen/P +Splunk/P +Spod/P +Spotify/P +Springboot/P +Spyre/P +Sql/P +Sqlite/P +Src/P +Ss/P +Sset/P +Sshd/P +Sshkey/P +Sshpas/SP +Sshpw/P +Sslcacert/P +Sslclientcert/P +Sslclientkey/P +Sslverify/P +Sss/P +Sssctl/P +Sssd/P +St/P +Stackdriver/P +Stackless/P +Stacktrace/SP +Stalld/P +Startx/P +Statefulness/P +Statefulset/SP +Statelessly/P +Stateroot/SP +Statuspage/P +Stderr/P +Stdin/P +Stdout/P +Stex/P +Stig/P +Stimer/P +Stonith/P +Storage/SP +Storageos/P +Storagestate/SP +Storageversionmigration/SP +Strace/P +Stratis/P +Streamable/P +Strided/P +Strigi/P +Strongimcv/P +Stunnel/P +Su/P +Subaddress/P +Subcapacity/P +Subcase/SP +Subchannel/SP +Subchapter/SP +Subcommand/SP +Subcomponent/SP +Subcontainer/SP +Subdevice/P +Subfield/SP +Subflow/SP +Subfolder/SP +Subfunction/P +Subid/P +Subinterface/P +Subkey/SP +Sublayer/P +Subline/P +Submenu/SP +Subnet/SP +Subnetwork/SP +Suboption/P +Subpackage/SP +Subpage/P +Subpath/SP +Subphase/SP +Subpolicy/SP +Subprocessor/SP +Subprotocol/P +Subresource/SP +Subsecond/P +Substate/P +Substep/SP +Substring/P +Subtab/SP +Subtest/SP +Subtree/SP +Subuser/SP +Subvolume/SP +Subzone/SP +Suchow/P +Sudo/P +Sudoer/SP +Suexec/P +Suitererunner/P +Superblock/SP +Supercede/SP +Superceded/P +Supermicro/P +Supermin/P +Superobject/P +Superscripted/P +Superset/P +Svc/P +Svgpart/P +Svrcore/P +Swappiness/P +Switchandtwoguest/SP +Swtpm/P +Symfony/P +Synchronizer/SP +Synic/P +Syntax/SP +Syscall/SP +Sysctl/SP +Sysf/SP +Syslinux/P +Syslog/P +Syslogd/P +Sysprep/P +Syspurpose/P +Sysroot/P +Sysstat/P +System/SP +Systemctl/P +Systemd/P +Systemtap/P +TD/SP +TGT/SP +THP/SP +TLB/SP +TLD/SP +TPM/SP +TPU/SP +TTL/SP +Tablespace/SP +Targetcli/P +Targetd/P +Tasklet/SP +Taskrun/SP +Tasks/P +Taskset/P +Tc/P +Tcl/P +Tclx/P +Tcp/P +Tcpdump/P +Tcpstat/P +Tdb/P +Teamd/P +Teardown/P +Tebibyte/SP +Techdoc/SP +Tekton/P +Telco/P +Telecom/P +Telekom/P +Template/SP +Templated/P +Templateinstance/SP +Templating/P +Temporality/P +Temurin/P +Tencent/P +Tensorflow/P +Tera/P +Tesseract/P +Testguest/P +Testhostgroup/P +Testnqn/P +Testparm/P +Testpmd/P +Testuser/P +Texinfo/P +Tftp/P +Tftpd/P +Th/P +Thanos/P +Thanosruler/SP +Theia/P +Themisto/P +Themself/P +Thermald/P +Thinpool/P +Thinvolume/P +Thorntail/P +Threema/P +Threescale/P +Thresholding/P +Thunderbird/P +Tibco/P +Tickles/P +Timedatectl/P +Timedatex/P +Timeflowend/P +Timeflowstart/P +Timeframe/P +Timereceived/P +Timerlat/P +Timeseries/P +Timeslice/P +Timesource/P +Timespace/P +Timespan/P +Timestamping/P +Timesync/P +Tini/P +Tinycdb/P +Tipc/P +Tk/P +Tkinter/P +Tkn/P +Tl/P +Tlbflush/P +Tlog/P +Tmpf/SP +Tmpfile/SP +Tmux/P +Tncfhh/P +Todo/SP +Tokenization/P +Tokenizer/SP +Tolerations/P +Toolbx/P +Toolchain/P +Toolkit/SP +Toolset/SP +Tooltip/SP +Topolvm/P +Totallimitsize/P +Touchpad/SP +Traceback/P +Tracepoint/SP +Traefik/P +Trainium/P +Trang/P +Transactionally/P +Transcode/P +Transcoded/P +Transcoding/P +Transpiler/P +Treefile/P +Trie/SP +Triggerbinding/SP +Triggertemplate/SP +Trojan/SP +Truststore/P +Tsdb/P +Tsflag/SP +Ttl/SP +Tty/P +Tunable/SP +Tuned/SP +Turbostat/P +Tuser/P +Twofish/P +Tx/P +Tyagi/P +Tz/P +UBI/SP +UDN/SP +UID/SP +UPG/SP +UPN/SP +URI/SP +URL/SP +USB/SP +Uber/P +Ubi/SP +Ubxtool/P +Udev/P +Udftool/SP +Udica/P +Udn/SP +Udp/P +Uefi/P +Uevent/SP +Ufshcd/P +Ui/P +Uid/SP +Ulimit/SP +Ultravisor/P +Umask/P +Umount/P +Unallocate/P +Uname/P +Unapplied/P +Unapply/P +Unapplying/P +Unarchived/P +Unary/P +Unassign/SP +Unbootable/P +Unbuffered/P +Uncached/P +Uncaching/P +Uncheck/P +Uncomment/P +Uncommented/P +Uncommenting/P +Unconfigure/SP +Unconfigured/P +Uncordon/SP +Uncordoned/P +Uncordoning/P +Uncore/P +Undefining/P +Undeploy/P +Undeploying/P +Undercloud/P +Underrun/P +Underutilizing/P +Unencrypted/P +Unenroll/SP +Unenrollment/P +Unescaped/P +Unexported/P +Unformatted/P +Unfragmented/P +Unicast/P +Unidled/P +Unidling/P +Unifdef/P +Uninstallation/P +Uninstrumented/P +Unioned/P +Unioning/P +Uniquifier/P +Unix/P +Unlink/SP +Unlinking/P +Unlocker/P +Unmanage/SP +Unmanaged/P +Unmap/P +Unmarshal/P +Unmarshaler/SP +Unmarshaling/P +Unmarshalling/P +Unmount/SP +Unmounted/P +Unmounting/P +Unobfuscated/P +Unoconv/P +Unorthographic/P +Unpackage/SP +Unpackaged/P +Unpadded/P +Unparsable/P +Unparseable/P +Unpart/P +Unpartitioned/P +Unpatched/P +Unpause/SP +Unpaused/P +Unpausing/P +Unport/SP +Unported/P +Unporting/P +Unprefixed/P +Unprocessable/P +Unprovisioned/P +Unquiesce/P +Unquiescing/P +Unrecoverably/P +Unreferenced/P +Unregister/P +Unregistering/P +Unreplicated/P +Unschedulable/P +Unschedule/P +Unscoped/P +Unselect/SP +Unselecting/P +Unset/SP +Unsetting/P +Unshare/P +Unstage/SP +Unstaged/P +Unstaging/P +Unsuspended/P +Unsynchronized/P +Untag/P +Untampered/P +Untarred/P +Untrusted/P +Unvalidated/P +Unversioned/P +Unwritable/P +Unzoned/P +Upcall/SP +Updater/SP +Upgradability/P +Upgradation/P +Uplink/P +Uploader/P +Uprobe/SP +Upsell/SP +Upselling/P +Upsert/P +Upskill/P +Upsold/P +Uri/SP +Uriparser/P +Url/SP +Usb/SP +Usbguard/P +Useradmin/SP +Usercache/P +Userdata/P +Userdefinednetwork/SP +Useridentitymapping/P +Userland/P +Userns/P +Userrestriction/SP +Userroot/P +Userspace/P +Usr/P +Ustr/P +Util/SP +Utilization/SP +Utsname/P +Uuid/SP +VCN/SP +VF/SP +VG/SP +VGW/SP +VHD/SP +VID/SP +VLAN/SP +VM/SP +VMA/SP +VMDK/SP +VMI/SP +VNF/SP +VPA/SP +VPC/SP +VPN/SP +VPU/SP +VRF/SP +VSB/SP +VSI/SP +VSL/SP +VSR/SP +VXLAN/SP +Vale/P +Valgrind/P +Validator/P +Valkey/P +Vapic/P +Varlink/P +Vcenter/SP +Vcluster/SP +Vcpu/SP +Vdb/P +Vdo/P +Vectorizer/P +Velero/SP +Venafi/P +Vendored/P +Vendoring/P +Venix/P +Vepa/P +Verifier/P +Vfat/P +Vfio/P +Vg/SP +Vgcfgrestore/P +Vhost/P +Viaq/P +Victorops/P +Viewbilling/P +Viewfile/P +Viewobj/P +Vigra/P +Vimrc/P +Vinagre/P +Viorng/P +Viostor/P +Virsh/P +Virt/P +Virtctl/P +Virtinterfaced/P +Virtio/P +Virtiofs/P +Virtnetworkd/P +Virtnodedevd/P +Virtnwfilterd/P +Virtqemud/P +Virtsecretd/P +Virtstoraged/P +Virtualize/P +Virtualized/P +Virtualizor/P +Virtualmachine/P +Vlan/SP +Vm/SP +Vmcore/P +Vmdk/SP +Vmimport/P +Vmlinuz/P +Vmname/P +Vmtoolsd/P +Vn/P +Vnc/P +Vnet/P +Volgroup/P +Volsync/P +Volumeattachment/SP +Volumepopulator/SP +Volumesnapshot/SP +Volumesnapshotclass/SP +Volumesnapshotcontent/SP +Voxtral/P +Vpc/SP +Vpindex/P +Vrf/SP +Vsftpd/P +Vsix/P +Vsphere/P +Vulkan/P +Vxlan/SP +WWID/SP +WWN/SP +Waagent/P +Wacom/P +Wakeup/P +Walkthrough/SP +Wasm/P +Watchpoint/SP +Waypipe/P +Wbinfo/P +Webex/P +Webhook/SP +Webpack/P +Webserver/SP +Websocket/SP +Wechat/P +Wget/P +Whitepaper/P +Whoami/P +Whois/P +Wifi/P +Wildfly/P +Winbind/P +Winsync/P +Wirelessly/P +Wireshark/P +Woopra/P +Wordnet/P +Wordpress/P +Workqueue/SP +Writeback/P +Wsize/P +Wsrep/P +Wvdial/P +Wwid/SP +Www/P +Xattr/P +Xchat/P +Xclock/P +Xconfig/P +Xen/P +Xeon/P +Xferstats/P +Xfs/P +Xfsdump/P +Xfsrestore/P +Xguest/P +Xhost/P +Xisdnload/P +Xl/P +Xlat/P +Xming/P +Xml/P +Xmlstarlet/P +Xmltoman/P +Xmvn/P +Xnest/P +Xorg/P +Xserver/P +Xsom/P +Xstream/P +Xth/P +Xulrunner/P +Xvattr/P +Xwayland/P +Xxhash/P +Xz/P +Yaml/P +Yana/P +Yara/P +Yeoman/P +Yq/P +Yubikey/P +Zerombr/P +Zfcp/P +Zhuyin/P +Zipkin/P +Zipl/P +Zlib/P +Znetconf/P +Zowe/P +Zsh/P +Zstandard/P +Zstd/P +Ztp/P +aacraid +accessor +ack +acpi +acpid +actioned +adata +adcli +addon/S +adm +adminnetworkpolicy/S +adminpolicybasedexternalroute/S +adoc +aduser +advancecomp +aescbc +agentless +aio +airgapped +akonadi +alacarte +alertingrule/S +alertmanager/S +alertmanagerconfig/S +alertrelabelconfig/S +allowlist/S +allowlisted +allowlisting +alwaysprompt +amd +annobin +annocheck +anonymized +answerfile +aoe/S +apc +apic +apiguardian +apirequestcount/S +apiserver/S +apisonator +approver/S +architected +archivable +arcmsr +aresource +arg/S +argo +argocd +arptable/S +asciibinder +asciidoc +asciidoctor +assumeno +assumeyes +async +ata +atime +attacher +attestor/S +attica +audiofile +auditability +auditable +auditctl +auditd +augenrule/S +ausearch +authconfig +authd +authfile/S +authorizer +authselect +autoactivated +autoactivation +autoconfig +autoconfiguration +autoconfigure +autodetected +autodiscover/S +autodiscovering +autodiscovery +autof/S +autofilled +autogenerate +autogroup/S +autoinstall +autoinstrumentation +autolink +automapper +automation/S +automember +automembership +automount +autonumber +autopart +autopopulate/S +autopopulated +autoreboot +autorelabel +autorid +autosavet/S +autoscale +autoscaled +autoscaler/S +autoscaling +autostart +autosuspend +autotl/S +avc +aws +az/S +azp +backend/S +backfill/S +backfilled +backfilling +backhaul +backlink/S +backoff +backport/S +backported +backporting +backpressure +backstore +backtrace +balancer/S +baref/S +baremetal +baremetalhost/S +baseband +baselineadminnetworkpolicy/S +basename +batcher +baz +bcel +bcrypt +bcull +bello +bfa +bfd +bgp +bindable +bindep +bindtype +binutil/S +bitmask +bitrate/S +bitwise +blackbox +blkid +blocklisted +blocklisting +blockmap +bltk +bluedevil +bluetooth +bluez +bmap +bmceventsubscription/S +bmh/S +bogo +bookinfo +bool +boolean +bootable +bootc +bootdev +bootimage/S +bootkit/S +bootlist +bootloader +bootmap +bootup +bootupd +borrowable +bot/S +bottlenecked +bpf +bpfman +bpftool +bpftrace +breakpoint/S +brltty +broadcasted +brun +bsdcpio +bsfm +bsi +bson +bsonobjectid +bstop +btn +btree +buddyinfo +bugfix +buildah/S +buildconfig +buildhost +buildroot +builtin/S +burstable +busybox +bwidget +byobu +bzr +cachedir +cachefilesd +cachepool +cacher +cainjector +callout/S +camelcased +canonicalization +canonicalized +canonicalizing +capturegroup/S +catalogd +catalogsource/S +catchpoint/S +ccis/S +ccoctl +cdrom +cdrskin +cel +ceph +cephfs +certf/S +certmonger +certutil +cgroup/S +chan +che +checkpointed +checkpointing +checkresult/S +checksu +checksumming +chipset/S +chkconfig +chrony +chroot +chrooting +chrt +chunklimitsize +ci +cib +cidr/S +ciphertext/S +classful +classload/S +classloaded +classloader +classloading +classpath +clearpart +cleartext +cli/S +clickjacking +clientid +clocksource +cloudcredential/S +cloudformation +cloudprivateipconfig/S +cloudwatch +clusterautoscaler/S +clustercatalog/S +clustercsidriver/S +clusterextension/S +clusterextensionrevision/S +clusterimagepolicy/S +clusterip/S +clusterlogforwarder/S +clusterlogging/S +clusteroperator/S +clusterresourcequota/S +clusterrole/S +clusterrolebinding/S +clusterserviceversion/S +clustertask/S +clustertriggerbinding/S +clusteruserdefinednetwork/S +clusterversion/S +cmd/S +cmdline +cn +cnic +cnt +cobertura +codeblock +codec/S +codemodel +coderay +cohabitating +colocate +colocated +colocating +colocation +commandline +compat +composability +composable +composef/S +conditionalize +conditionalized +conditionalizing +config/S +configmap/S +conformant +conmon/S +connmark +consoleclidownload/S +consoleexternalloglink/S +consolelink/S +consolenotification/S +consoleplugin/S +consolequickstart/S +consolesample/S +consoleyamlsample/S +container/S +containerd +containerruntime/S +containerruntimeconfig/S +controllerconfig/S +controlplanemachineset/S +cooldown +coolkey +coredumpctl +corequisite +coreutil/S +corosync +cpptest +cppunit +cpu/S +cpufreq +cpuid +cpupower +cpuset/S +crashloopback/S +crashlooping +createfile +createrepo +credentialsrequest/S +crio +crl/S +cron +cronjob/S +crontab +crun +crypto +cryptoprocessor +cryptsetup +crypttab +cs +csi +csisnapshotcontroller/S +cstate +ctc +ctdb +cui +custodia +customisable +customizer +cutover +cv +cvsp/S +cyberattack +cybercrime +cybersecurity +cyclictest +cypher/S +czvf +daemon +daemonless +daemonset/S +dagre +dapl +dasd/S +dasdfmt +datacenter/S +dataclass/S +datafile +datagram +dataimage/S +dataloader/S +datamover +datapoint/S +datasource +datastore/S +datastream +datavolume +datestamped +datetime +dax +dbu/S +dbx +dconf +deallocate +deallocated +deallocating +deallocation +deauthenticate +deauthorize +debugf/S +debuggability +debuginfo +debuglevel +debugmode +debugsource +decapsulation +declarative +declaratively +decompiler +deconflict +dedupe +deduplicate/S +deduplicated +deduplicating +deduplication +defragment/S +defragmentation +defragmented +defragmenting +dejagnu +deltaiso +deltarpm +demangling +demodularized +demouser +dentry/S +denylist +deploy +deployer/S +deploymentconfig/S +depmod +deprovision +deprovisioned +deprovisioning +depsolve +depsolving +dequeue/S +dequeuing +dereference +dereferenced +dereferencing +deschedule/S +descheduled +descheduler +descheduling +descriptor +deserializable +deserialization +deserialize/S +deserialized +deserializer +deserializing +destructor/S +desynchronization +desynchronize/S +desynchronized +desynchronizing +dev +devcatalog +devfile/S +devicevolume +devlink/S +devnode +dex +df +dgst +dhclient +dhcp +dhcpd +dialog/S +dict/S +disallowment +discoverability +disklabel/S +diskless +diskmaker +diskspace +diskspacecheck +disruptable +distinguisher/S +distro/S +django +dmesg +dmraid +dn/S +dnf +dnsmasq +dnsrecord/S +dnstap +dockerfile/S +docstore +docstring/S +domainname/S +donut +dosfstool/S +dotnet +downloader +downsampled +downsampling +downscaling +downstream/S +downstreamed +downstreaming +downtime/S +dp +dpdk +dracut +driverctl +driverdisk +driverless +dropbox +drpm +drpmsync +drupal +dscp +dstat +dstrct +dtdinst +dualstack +dumpet +dumpxml +dvd +dvgrab +dvice/S +dwarf +dwarves +dwz +easymock +eb/S +ebpf +ebtable/S +ecj +editability +efax +efibootmgr +egressfirewall/S +egressip/S +egressqos/S +egressrouter/S +egressservice/S +ekiga +elasticloadbalancing +elasticsearch +elfutil/S +elink/S +emptydir +enablegroup/S +enablement +encoding +endian +endif +englightbox +enlightbox +enlightenment/S +enqueue/S +enqueued +enricher +enum +env/S +eod +eport/S +epydoc +errorlevel +espeak +etcd/S +etcdctl +ethernet +ethtool +etype +eu/S +eula +eventlistener/S +evmc/S +exactarchlist +examplepath +excludable +excludelist +exe +exec +execstack +existingfile +expander/S +expectk +expiration +exposable +exposal +expr +externalname +extlinux +extranet +extrapartition +faceplate/S +fadump +failback +failover +fakeroot +fapolicy +fapolicyd +farstream +fastpath +favicon/S +fc +fcntl +fcoe +fcull +fdasd +fdatasync +fdisk +featuregate/S +featureset +fedc +fedcb +fielddata +fieldset/S +filebench +fileio +filelist +filepath/S +filesaving +fileshare +filestore +filesystem/S +finalizer/S +findability +finetune/S +finetuned +finetuner +finetuning +fio +fip/S +firefox +firewalld +firewalling +firmware/S +firmwareschema/S +firstboot +firstimage +flamegraph/S +flocker +flowlog/S +flowtable/S +fluentd/S +flushinterval +flushmode +flushthreadcount +fonttool/S +footnoteref +freerdp +fro/S +fromon +fromui +fronthaul +frr +frun +fsck +fsf +fsid +fstab +fstop +fstrm +fstype +fsync +ftrace +fullname +fullpack +func +fuseiso +futex +gatewayclass/S +gbps +gc +gcab +gcc +gce +gcloud +gcloudcompute +gcp +gdb +gdbm +gdm +gedit +genai +genpkey +geo +geoclue +geospatial +getdent +getsubid +ghostscript +gibibyte/S +giga +github +gitlab +gitop/S +glew +glibc +glock/S +glstat/S +glusterfs +gmp +gnote +godoc +gofmt +golang/S +goroutine/S +govc +gperftool/S +gpgcakey +gpgcheck +gpgkey +gpsd +gpspipe +gpt +gradle +grafana/S +grantlee +granularity/S +grayscale +greenboot +groupofname/S +grouprestriction/S +growpart +grpc +gsetting/S +gssntlmssp +gstreamer +gsutil +gucharmap +guestf/S +gutenprint +gvncpulse +gw +gwenview +gz +gzip +gzipped +hadamard +hamcrest +hardcode +hardcoded +hardcoding +harddrive +hardlink/S +hardlockup +hardwaredata +hashbang/S +hashmap +hawkey +hcp/S +healthcheck +healthz +heatmap/S +helmchartrepository/S +helpdesk +heredoc/S +heterogeneous +hexchat +hexcolor/S +hextet/S +highport +hipaa +hivex +hmaccalc +hmc +hoc +hookpoint/S +hostapd +hostcluster/S +hostfile +hostfirmwarecomponent/S +hostfirmwaresetting/S +hostgroup/S +hostname/S +hostpath +hostupdatepolicy/S +hostwithnatswitch +hotplug +hotspot/S +hpij/S +hplip +hpsa +hptiop +href +hsakmt +hsqldb +htdig +html +htmltest +htpasswd +http/S +httpd +httproute/S +hugepage/S +hwlatdetect +hyperconverged +hyperdisk +hyperscale +hyperscaler +hyperthreading +iamserviceaccount/S +ibmcloud +ibmcos +iburst +ibutil/S +icsp/S +idempotence +idmap +idmclient +idmgroup +idmserver +idmuser +idoverridegroup +idoverrideuser +idp/S +idview +ifcfg +ifconfig +ifdef +ifeval +ifndef +ignoredisk +ilo +imagedigestmirrorset/S +imagepolicy/S +imageregistry +imageset +imagestream/S +imagestreamimage/S +imagestreamtag/S +imagetagmirrorset/S +imake +img +immediate +impactful +implementor +imsetting/S +includepkg/S +incore +inetorgperson +inetuser +inference/S +inferenced +inferencing +infiniband +ing +ingester/S +ingresscontroller/S +ingressgateway/S +ini/S +iniparser +initialism/S +initializer/S +initio +initramf/S +initrd +initscript/S +inline/S +inlined +inode +inplace +installonlypkg/S +installplan/S +installrootkeep +instancetype +instantiator/S +instruction/S +instrumentation/S +intel +interdomain +interoperate +interoperating +intracluster +intranode +intrapartition +intrarecord +intraservice +intrasystem +invalidation/S +invocable +iok +iopen +iostat +ip/S +ipa +ipaclient/S +ipactl +ipaddres/S +ipaddress/S +ipaddressclaim/S +ipadnsconfig +ipagroup +ipahost +ipaidp +ipam +ipaobject +ipaserver +ipasshuser +ipausergroup +ipc +ipfix +ipi/S +ipmievd +ipmitool +ippool/S +iproute +ipsec +ipsilon +iptable/S +iputil/S +ipvlan +iqn/S +irdma +irq/S +irqbalance +irqsoff +irreproducibility +irssi +isbn +isci +iscsi +iscsiadm +iscsiname +iso/S +isorelax +iss +istio/S +istioctl +istiod/S +jabberpy +jackson +jaf +jandex +jarjar +javac +javamail +javascript +jaxen +jbigkit +jctool/S +jdata +jdom +jemalloc +jigawatt/S +jing +jira +jmc +jna +joesec +journal/S +journalctl +journald +journaled +journaling +jq +jruby +js +jsmith +json +juk +junit +jvm +kaccessible +kactivitie/S +kafka +kamera +kate +kbd +kcalc +kcharselect +kcolorchooser +kcoloredit +kdeaccessibility +kdeadmin +kdeartwork +kdegraphic/S +kdelib/S +kdemultimedia +kdenetwork +kdepim +kdepimlib/S +kdesdk +kdeutil/S +kdf +kdump +keda +keepalive +keepalived +keepcache +kepler +kerberize +kerberized +kerberos +kernelpkgname/S +kernelshark +kexec +keycloak/S +keyfile/S +keyless +keylime +keymap/S +keypair/S +keyphrase +keyring/S +keyserver +keyslot +keyspace +keystore +keytab/S +kgamma +kgpg +khotkey/S +kiali +kibana +kickstart/S +kiconedit +kinfocenter +kinit +klist +klog +klusterlet +kmag +kmenuedit +kmix +kmod/S +knative +knet +knowledgebase +kolourpaint +konkretcmpi +konnectivity +konsole +kpatch +kprobe/S +krbprincipalaux +krbticketpolicyaux +kruler +ksaneplugin +kscreen +ksdevice +ksmd +ksnapshot +ksonnet +ksshaskpas/S +ksysguard +ksysguardd +ktimer +kube +kubeadmin +kubeconfig +kubectl +kubedns +kubelet/S +kubeletconfig +kubeproxy +kubernetes +kubernetesenv +kubevirt +kustomization +kustomize +kvm +kwallet +kwin +kwrite +kxml +langpack/S +latencytop +latrace +layernorm +lc +ld +ldap +ldapmodify +ldapsearch +ldconfig +ldns +leapp +leptonica +leveloffset/S +lftp +libaio +libappindicator +libbabeltrace +libbluedevil +libbonobo +libbonoboui +libbpf +libc +libchewing +libcmpiutil +libcrypto +libdb +libdbi +libdnf +libecpg +libee +libesmtp +libfdt +libg/S +libgccjit +libgcrypt +libgepub +libgnat +libgnome +libgnomecanvas +libgnomeui +libgo +libgudev +libguestf/S +libgxim +libhangu +libhif +libibcommon +libibmad +libidn +libij/S +libindicator +libinput +libiodbc +libiscsi +libkcddb +libkcompactdisc +libkdcraw +libkipi +libkkc +libksane +libkscreen +libkworkspace +liblockfile +libmemcached +libmodulemd +libmsn +libmudflap +libmusicbrainz +libmx +libnbd +libnetapi +libnice +libnl +libnma +libnmstate +libnsl +libntlm +libnumbertext +libobjc +libofa +liboil +libomp +libpgtype/S +libpinyin +libpmemcto +libpod +libpq +libpst +libpwquality +librados +librbd +libreoffice +libreswan +librt +librtk +librtkaio +libsecret +libsexy +libslirp +libssh +libssl +libtpm/S +libtraceevent +libtracef/S +libtranslit +libunwind +liburing +libvirt +libvirtd +libwbclient +libwinpr +libwpe +libwvstream/S +libxcrypt +libxdp +libxmlb +libzapojit +libzhuyin +libzstd +licensor +lifecycled +lightbox +linearization +linearize +linux +linuxptp +liquibase +liveimg +liveness +lld +lldb +llvm +lmdb +loadbalancer/S +loadbalancing +localnet +localssd +lockdown/S +lockfile +lockless +lockspace +logcollector +logfile +logicalvolume/S +loginuid +logrotate +logvol +loki +lokistack +lookaside +lookback +lookup/S +loopback +lowercase/S +lowercased +lpadmin +lpar/S +lpfc +lshw +lsname +lstopo +ltrace +lua +lucene +luk/S +luksmeta +lun/S +lvm +machineautoscaler/S +machinehealthcheck/S +machineosconfig/S +machinepool/S +machineset/S +macrostructure +macvlan +macvtap +madvise +mainboard +makedumpfile +makefile/S +manpage +mariabackup +maskable +matcher/S +matchrule +matrixes +maxpoll +mcollective +md +mdadm +mddownloadpolicy +mdev +mdevctl +mdpolicy +mebibytes +mediacheck +memberlist +membermanager +memcache +memcg +memnode +memstick +memstomp +memstrack +mergeable +metacharacter/S +metaclass +metafile +metalink +metamodel +metapackage +metatable +mgetty +mgmt +mib +microarchitecture/S +microdnf +micropipenv +microsegmentation +microservice/S +middleware +midhaul +migplan +migr +migratable +migrationtool/S +migstorage +miimon +millicore/S +millicpu +mimetype +min +minicourse +minidisk +minimalistic +minizip +minpoll +minrate +mirrorlist +misconfiguration/S +misconfigured +mitigation/S +mixin/S +mkbootdisk +mkf/S +mkinitrd +mmc +mng +mntpoint +modesetting +modrdn +modularization +modularize +modulefile/S +mokutil +monorepo/S +monospace +monospaced +monthday/S +mountd +mountpoint/S +mountstat/S +mpage +mpdecimal +mpich +mpirun +mptbase +mptcpd +mptcpize +mptctl +mptsa/S +mptscsih +mptspi +msbuild +msdo/S +msg +mssql +mthca +mtime +mtl/S +mtu/S +multibyte +multicast +multicloud +multicluster +multifactor +multihop +multihost +multilib +multiline +multimodal +multinode +multipath +multipathed +multipathing +multipoint +multiport +multiprogram +multiprotocol +multiqueue +multischema +multisite +multitable +multitenancy +multitenant +multithread +multithreading +multitier +multitiered +multiuser +multivendor +multizone +multu/S +mutex/S +mvsa/S +mvumi +myapp +mydestination +mydomain +myecho +mylv +mynetwork/S +myproject +mysql +mysqldump +mythinsnap +myubi +myvdo +myvg +na +nameserver/S +namespace/S +namespaced +namespacing +nano/S +nasm +nbctl +nbdb +nbdfuse +ndctl +nekohtml +nestedgroup +netavark +netboot +netcf +netclass/S +netconsole +netdev +netdevice +netgroup/S +netlink +netmask +netobserv +newdisk +newecho +newrdn +nf/S +nfp +nfsnobody +nfsometer +nfstest +nftable/S +nginx +nic/S +nicpf +nicvf +nispor +nlb/S +nlt +nm +nmcli +nmstate +nmstatectl +nmtui +noarch +nodeagent +nodejs +nodename/S +nodeport +nodeselector/S +nodesliceippool/S +nodeslicepool/S +noexec +nohotcorner +nohz +nonauthoritative +nondefault +nondestruct +nonexpiring +nonheap +noninteractive +nonlocal +nonoverlapping +nonpaired +nonposix +nonrecovery +nonrecursive +nonrenewal +nonroot +nonsystem +nop +northd +nosmt +nosniff +notchecked +npm +npth +nsenter +nslcd +nsswitch +nsupdate +nt +ntfs +ntlm +ntlmssp +ntp +ntpd +ntpdate +ntpdc +ntpq +ntpstat +num +numactl +numaresourcesoperator/S +numastat +numatop +numpy +nutanix +nuxwdog +nvdimm/S +nvme +nvmetcli +oauth +oauthaccesstoken/S +oauthauthorizetoken/S +oauthclient/S +obexd +oc +ocaml +oci +ocm +ocp +ocsp +odc +odo +offboard/S +offboarded +offboarding +offlined +oidc +okindf +okular +olm/S +olmconfig/S +omnichannel +onboard/S +onboarded +onboarding +oneshot +onlining +opae +opencc +opencv +openid +openjade +openjpeg +openlmi +openmpi +openobex +opensc +openscap +openshiftapiserver/S +openshiftcontrollermanager/S +opensp +openssl +openstack/S +openvswitch +oper +operator +operatorcondition/S +operatorgroup/S +operatorpki/S +oplock +opm +oprofile +optipng +organizationalperson +ortp +osad +osbuild +osd/S +oslat +osname +ospp +ossm +osst +ostoy +ostree +ostreecontainer +ostreesetup +otlp +outfile +overcommit +overcommitted +overcommitting +overflowaction +overlappingrangeipreservation/S +overprovisioned +overprovisioning +overridable +overriden +overstrike +overutilized +overvoting +overwritable +ovirt +ovn +packagemanifest +packageserver +pagecache +papi +parallelization +param/S +parameterization +paravirtual +paravirtualization +paravirtualized +parksmap +parm +parsable +parseable +passdb +passivetex +passt +passthrough +passwd +passwordless +pata +pathgroup +pathname/S +pc +pcm +pcp +pcre +pcsd +pello +perf +performanceprofile/S +performant +perl +perltidy +persistdir +persistentvolumeclaim/S +pexpect +pgaudit +php +pid +pingable +pinnedimageset/S +pipelined +pipelinerun/S +pipelining +pixtral +pkc/S +pkey +pkgconfig +pkinit +plaintext +pluggable +pluginconfpath +pluginpath +pmc +pmcd +pmchart +pmcraid +pmem +pminfo +pmlogconf +pmlogger +pmproxy +pmrep +pmserie/S +pmstore +pngcrush +pngnq +po +poddisruptionbudget/S +podman +podmonitor/S +podnetworkconnectivitycheck/S +polkit +polling/S +polyinstantiated +polyinstantiation +populator/S +portforward +portgroup +portmapper +portworx +postedit/S +postedited +postediting +posteditor +postgre/S +postgresql +postinstall +postinstallation +postoperation +postprocessing +postqueue +postrequisite +poweroff +powersave +powersaving +powershell +powertop +powervs +ppd/S +pprof +pragma +pre +preallocate/S +preallocated +preallocating +preallocation +preauthentication +preboot +prebuild +precache/S +precached +precaching +precompile/S +precompiled +precompute +precomputing +preconfiguration +preconfigure/S +preconfigured +preconfiguring +preconnect/S +precreate +preemptible +preemption/S +preemptirqsoff +preemptoff +preenrollment +prefetch +prefill +prefork +preformat/S +preformatted +preformatting +pregenerate/S +pregenerated +pregenerating +pregeneration +preinstall +preinstallation +preinstalling +prelink +preload +preloaded +preloading +preoperational +prepend/S +prepended +prepending +prepopulate +prepopulated +preprocess +preprocessor +preprovisioning +preprovisioningimage/S +prereq +prerequired +prerollback +preruntime +presigned +pretrained +preupgrade +printk +prioritizer/S +priorityclass/S +privatelink +prober/S +productization +productize/S +productized +productizing +productpage +profileparser +profiler +projecthelmchartrepository/S +prometheus +prometheusrule/S +promql +protobuf +provisionator +provisioner/S +proxied +proxying +psample +pscsi +pseudocode +pseudorandom +pseudotext +psql +psutil/S +pth +pthread/S +ptlib +pulldown +pullspec +pullthrough +pushpull +pvc +pvck +pvcreate +pvpanic +pxelinux +qatengine +qatlib +qatzip +qdisc/S +qdmanage +qdox +qdstat +qeth +qimageblitz +qjson +qlcnic +qlge +qnetd +qos +quantizable +quantization +quantize/S +quantized +quantizer +quantizing +querier +queryable +querylog +quickstart/S +quiescing +quobyte +quotacheck +quotasync +qxl +racadm +radvd +raleigh +ramdisk +rangeallocation/S +rangesize +rasdaemon +rase +rawip +rbac/S +rbd +rc +rd +rdate +rdist +reachability +reactively +readahead +readlinelimit +readonly +realmd +realtime +reauthenticate/S +reauthenticated +reauthenticating +reauthentication +rebalance/S +rebalanced +rebalancer +rebalancing +rebase/S +rebased +rebasing +recertification/S +rechunk +rechunking +recommender/S +reconciler/S +recordset +recursing +recursor/S +redcircle +redeployment/S +redi/S +redirection/S +redirector/S +redistributable +reenable/S +reenabled +reenabling +reencrypt +reencrypted +reencrypting +reenlightenment +reentrant +referenceable +referencegrant/S +reflink +reflinked +reformat/S +refreshable +regedit +regionalized +reimage +reimaging +reimplementation +reindex/S +reindexed +reindexer +reindexing +reinitialization +reinitialize/S +reinitializing +reinstall/S +reinstallation +rekey +rekeyed +rekeying +relabeling/S +relaxngcc +releasever +reloadable +relocation/S +remediation/S +remediator +remirror +remirroring +remotebaud +remoting +remountable +renderedmachineconfig/S +replaceable/S +replicaset/S +repo/S +repodata +repositoryid +reposync +reprovision +reprovisioned +reprovisioning +repurpose +reqpart +requestor +requeue/S +requeued +rescan +rescanning +resctl +reshard/S +resharded +resharder +resharding +resizable +resizef/S +resizer +resnet +resourcegroupstaggingapi +responder/S +resteasy +restic +restorecon +resultserver +resync/S +resynced +resyncing +retrigger +retrymaxinterval +retrytimeout +retrytype +retrywait +reusability +revisioned +rfc +rfkill +rgb +rgbcolor +rgrp +rh +rhc +rhcd +rhdh +rhel +rhev +rhncfg +rhnpush +rhscl +rhsm +rkt +rngom +ro +rolebinding/S +rolebindingrestriction/S +rollout/S +rollup/S +rootf/S +rootful +rootless +rootpw +rosa +roundrobin +roundtable/S +routable +routing/S +rpc/S +rpcbind +rpcclient +rpcgen +rpm/S +rpmnew +rpmsave +rpmverbosity +rsh +rshared +rshim +rsize +rslave +rsync +rsyslog +rtcdata +rtcheck +rtctl +rteval +rtla +rulebook +ruleset +runbook/S +runc +runcmd +runlabel/S +runlevel/S +runpath +runtime/S +ruser/S +rustfmt +rw +rwho +rwx +rwxrwxrwx +rx +sadc +sadump +safetensor/S +sameorigin +samepage +sandboxed +sandboxing +sanlock +sapconf +sar +satisfiability +saxon +sbc +sbd +sbt +sca +scaffolded +scaffolder +scaledown +scaler/S +scannotation +scap +scatterchart +sched +schedulability +schedulable +scheduler +scipy +scon/S +scpio +scriptable +scriptlet/S +scrollbar +scsi +sctp +sda +sdk/S +sdparm +searchability +seccomp +secureboot +securitycontextconstraint/S +sed +selinux +semanage +semver +sendmail +serializable +serialization +serializer +serverless +serviceaccount/S +serviceaccountrestriction/S +servicemonitor/S +servicequota +servlet +setgid +setter +setuid +setuptool +sevctl +sfc +sftp +sgabio/S +sgc +shard/S +sharded +sharding +shotwell +showback +showdupesfromrepo/S +shows +shufflesharding +sid/S +sidecarless +sideload +sideloaded +sigstore +sinked +sisu +siw +skipx +skopeo +sla +sm +smarthost +smb +smbcacl/S +smbclient +smbcontrol +smbpasswd +smbstatus +smbtar +smoothquant +smp +smtp +sn +snactor +snakeyaml +snapset +snapshotted +snapshotter +snapshotting +sntp +so +softdog +software/S +somelibrary +soname +sosreport/S +sourcestat/S +sourcetype/S +sox +spacebar +spamc +spamd +sparsification +sparsified +sparsify/S +sparsifying +speex +speexdsp +spindown +spinlock/S +splunk +spod +spyre +sql +sqlite +src +ss +sset +sshd +sshkey +sshpas/S +sshpw +sslcacert +sslclientcert +sslclientkey +sslverify +sss +sssctl +sssd +st +stacktrace/S +stalld +startx +statefulness +statefulset/S +statelessly +stateroot/S +statuspage +stderr +stdin +stdout +stex +stig +stimer +stonith +storage/S +storageos +storagestate/S +storageversionmigration/S +strace +streamable +strided +strigi +strongimcv +su +subaddress +subcapacity +subcase/S +subchannel/S +subchapter/S +subcommand/S +subcomponent/S +subcontainer/S +subdevice +subfield/S +subflow/S +subfolder/S +subfunction +subid +subinterface +subkey/S +sublayer +subline +submenu/S +subnet/S +subnetwork/S +suboption +subpackage/S +subpage +subpath/S +subphase/S +subpolicy/S +subprocessor/S +subprotocol +subresource/S +subsecond +substate +substep/S +substring +subtab/S +subtest/S +subtree/S +subuser/S +subvolume/S +subzone/S +sudo +sudoer/S +suexec +suitererunner +superblock/S +supercede/S +superceded +supermin +superobject +superscripted +superset +svc +svgpart +svrcore +swappiness +switchandtwoguest/S +swtpm +synchronizer/S +synic +syntax/S +syscall/S +sysctl/S +sysf/S +syslinux +syslog +syslogd +sysprep +syspurpose +sysstat +system/S +systemctl +systemd +tablespace/S +targetcli +targetd +tasklet/S +taskrun/S +tasks +taskset +tc +tcl +tclx +tcp +tcpdump +tcpstat +tdb +teamd +teardown +techdoc/S +telco +telecom +template/S +templated +templating +temporality +tera +tesseract +testguest +testhostgroup +testnqn +testparm +testpmd +testuser +texinfo +tftp +tftpd +th +thanos +thanosruler/S +theia +themself +thermald +thinpool +thinvolume +threescale +thresholding +thunderbird +tickles +timedatectl +timedatex +timeflowend +timeflowstart +timeframe +timereceived +timerlat +timeseries +timeslice +timesource +timespace +timespan +timestamping +timesync +tini +tinycdb +tipc +tkinter +tkn +tl +tlbflush +tlog +tmpf/S +tmpfile/S +tmux +tncfhh +todo/S +tokenization +tokenizer/S +tolerations +toolchain +toolkit/S +toolset/S +tooltip/S +topolvm +totallimitsize +touchpad/S +traceback +tracepoint/S +trang +transactionally +transcode +transcoded +transcoding +treefile +triggerbinding/S +triggertemplate/S +trojan/S +truststore +tsdb +tsflag/S +ttl/S +tty +tunable/S +tuned/S +tuser +tz +ubi/S +ubxtool +udev +udftool/S +udica +udn/S +udp +uefi +uevent/S +ufshcd +ui +uid/S +ulimit/S +ultravisor +umask +umount +unallocate +uname +unapplied +unapply +unarchived +unassign/S +unbootable +unbuffered +uncached +uncheck +uncomment +uncommented +uncommenting +unconfigure/S +unconfigured +uncordon/S +uncordoned +uncordoning +uncore +undefining +undeploy +undeploying +undercloud +underrun +underutilizing +unencrypted +unenroll/S +unenrollment +unescaped +unexported +unformatted +unfragmented +unicast +unidled +unidling +unifdef +uninstallation +uninstrumented +unioned +unioning +uniquifier +unix +unlink/S +unlocker +unmanage/S +unmanaged +unmap +unmarshal +unmarshaling +unmarshalling +unmount/S +unmounted +unmounting +unobfuscated +unoconv +unorthographic +unpackage/S +unpackaged +unpadded +unparsable +unparseable +unpart +unpartitioned +unpatched +unpause/S +unpaused +unpausing +unport/S +unported +unporting +unprefixed +unprovisioned +unquiesce +unquiescing +unrecoverably +unreferenced +unregister +unregistering +unreplicated +unschedulable +unschedule +unscoped +unselect/S +unselecting +unset/S +unsetting +unshare +unstage/S +unstaged +unstaging +unsuspended +unsynchronized +untag +untampered +untarred +untrusted +unvalidated +unversioned +unwritable +unzoned +upcall/S +updater/S +upgradability +upgradation +uplink +uploader +uprobe/S +upsell/S +upselling +upsert +upskill +upsold +uri/S +uriparser +url/S +usb/S +usbguard +useradmin/S +usercache +userdata +userdefinednetwork/S +useridentitymapping +userns +userrestriction/S +userroot +userspace +usr +ustr +util/S +utilization/S +utsname +uuid/S +valgrind +validator +vapic +varlink +vcenter/S +vcluster/S +vcpu/S +vdb +vdo +vectorizer +velero/S +vendored +vendoring +vepa +verifier +vfat +vfio +vg/S +vgcfgrestore +vhost +victorops +viewfile +viewobj +vigra +vimrc +vinagre +viorng +viostor +virsh +virt +virtctl +virtinterfaced +virtio +virtiofs +virtnetworkd +virtnodedevd +virtnwfilterd +virtqemud +virtsecretd +virtstoraged +virtualize +virtualized +virtualizor +virtualmachine +vlan/S +vm/S +vmcore +vmdk/S +vmimport +vmlinuz +vmname +vmtoolsd +vn +vnc +vnet +volgroup +volumeattachment/S +volumepopulator/S +volumesnapshot/S +volumesnapshotclass/S +volumesnapshotcontent/S +vpc/S +vpindex +vrf/S +vsftpd +vsix +vsphere +vulkan +waagent +wakeup +walkthrough/S +wasm +watchpoint/S +waypipe +wbinfo +webex +webhook/S +webserver/S +websocket/S +wechat +wget +whitepaper +whoami +whois +wifi +winbind +wirelessly +wireshark +wordnet +wordpress +workqueue/S +writeback +wsize +wsrep +wvdial +wwid/S +www +xattr +xchat +xclock +xconfig +xferstats +xfs +xfsdump +xfsrestore +xguest +xhost +xisdnload +xl +xlat +xml +xmlstarlet +xmltoman +xmvn +xsom +xstream +xth +xulrunner +xvattr +xxhash +xz +yaml +yara +zerombr +zfcp +zipl +znetconf +zsh +zstd +ztp diff --git a/.github/styles/RedHat/dictionaries/wordlist.txt b/.github/styles/RedHat/dictionaries/wordlist.txt new file mode 100644 index 00000000..a1c47e2d --- /dev/null +++ b/.github/styles/RedHat/dictionaries/wordlist.txt @@ -0,0 +1,4058 @@ +# Red Hat dictionary wordlist +# +# Source of truth for en_US-RedHat.dic. Run tools/build-dictionary.py +# to regenerate the dictionary after editing this file. +# +# Format: one plain text word per line. No special Hunspell flags needed. +# +# - Include both singular and plural forms (e.g., API and APIs). +# The build script detects plurals and consolidates them with /S flags. +# - Lowercase words automatically get a Title Case counterpart +# (e.g., "spyre" also generates "Spyre"). +# - Capitalized words automatically get a possessive form +# (e.g., "Docker" also generates "Docker's"). +# - For proper nouns and acronyms, use the exact casing you need +# (e.g., "Docker", "AWS"). +# +# No need to sort entries or maintain a word count. + +ACI +ACIs +ACL +ACLs +AEE +AEEs +ALUA +AMI +AMIs +ANP +ANPs +AOE +AOEs +API +APIs +ARG +ARGs +ARN +ARNs +ASIC +ASICs +AWS +AZ +AZes +Adaptec +Agroal +Aidan +Alibaba +Andi +Ansible +Antora +Applixware +Appstream +Arcee +Artifactory +Aruna +Aspeed +Associable +Attr +Autokey +Autom +Avahi +Axio +Axios +Azure +BANP +BANPs +BIOS +BMC +BMCs +BMH +BMHs +BOM +BSL +BSLs +Backgrounded +Backplane +Backtracing +Bacula +Bierner +Bitbucket +Bitwarden +Bonjour +Broadcom +Btfr +Btfrs +Btrfs +Bugzilla +Buildpack +Buildpacks +Bundler +Bz +Bzes +CA +CAs +CIDR +CIDRs +CIL +CKAID +CKAIDs +CLB +CLBs +CLI +CLIs +CNF +CNFs +CNI +CNIs +CPU +CPUs +CR +CRs +CRD +CRDs +CSP +CSPs +CSR +CSRs +CSV +CSVs +CUDN +CUDNs +CVO +CVOs +Cachevol +Caikit +Canonicalize +Cavium +Cflag +Cflags +Changhua +Che-Theia +Chronyd +Civetweb +Clariion +Cloudbursting +Cloudfront +Cloudian +Cloudwashing +Codewind +Columbiaville +Connectionless +Containerfile +Containerfiles +Cookiecutter +Corefile +Cosign +Cosigns +Ctrl +Cuda +Cyber +Cygmon +Cython +DASD +DASDs +DB +DBs +DC +DCs +DIMM +DIMMs +DLM +DLMs +DN +DNs +DNF +DNS +DPA +DPAs +DPU +DPUs +DSO +DSOs +DU +DUs +DV +DVs +DVD +Dalle +Dalles +Dammam +Datadog +Datapath +Datatracker +Deis +Diffserv +Docker +Dogtag +Dovecot +Drilldown +Dst +Dx +Dymo +Dyninst +EIP +EIPs +ELB +ELBs +ENI +ENIs +Ei +Emacs +Emulex +Endevor +Entra +Equinix +Esprima +Etherchannel +Ethertype +Eventing +Exbibyte +Exbibytes +Exif +FIFO +FIP +FIPs +FPGA +FPGAs +FQDN +FQDNs +Fabrice +Facter +Factories +Factory +Failsafe +Fernflower +Filelog +Flathub +Flatpak +Flexran +Flyway +Fortran +Fortville +Freedesktop +Fulcio +Funqy +GCC +GID +GPO +GPOs +GPU +GPUs +GTID +GTIDs +GUI +GVK +GVKs +Galera +Gaudi +Gemalto +Geneve +Gestetner +Ghislain +Giesecke +Gitea +Gluster +Glusterfs +Godebug +Gog +Gogs +Grafea +Grafeas +Graylog +Gregor +Gtk +HBA +HBAs +HCA +HCAs +HCP +HCPs +HDD +HDDs +HPA +HPAs +HSM +HSMs +HT +HTs +HTTP +HTTPS +Hamina +Hashicorp +Hawkular +Heapster +Helgrind +Helm +Hiper +Hipers +Hipersocket +Hipersockets +Hitm +Homebrew +Hotfix +Hotfixes +Hunyuan +Hypershift +ICSP +ICSPs +IDE +IDP +IDPs +IFL +IFLs +IME +IMEs +IO +IOs +IOCTL +IOCTLs +IOP +IOPs +IP +IPs +IPA +IPI +IPIs +IQN +IQNs +IRQ +IRQs +IRTT +IRTTs +ISO +ISOs +ISP +ISPs +Idm +Inferentia +Infinispan +Infoblox +Infotec +Inlining +Intelephense +Intellij +Intersight +Interzone +Intrazone +Ipsum +Itanium +JDK +JDKs +JRE +JREs +JVM +JWT +JWTs +Jaeger +Jaegers +Jakarta +Java +Jboss +Jenkinsfile +Jolokia +Journalling +Joyent +Jurong +KDC +KDCs +KPI +KPIs +KRA +KRAs +KVM +Kaniko +Kata +Katello +Kbase +Kbyte +Kbytes +Kibibyte +Kibibytes +Kinesi +Kinesis +Kogito +Kompose +Konflux +Kopia +Kourier +Krew +Kronosnet +Kubebuilder +Kubespray +Kueue +Kueues +Kylin +Kyocera +LAN +LANs +LBN +LBNs +LCU +LCUs +LLM +LLMs +LPAR +LPARs +LUN +LUNs +LV +LVs +LVS +LVSes +Lanier +Laravel +Lenovo +Lexmark +Libica +Lightspeed +Lmod +Loglevel +Logstash +Lombok +Lorax +Lrecl +MB +MBs +MCP +MCPs +MSA +MSAs +MSR +MSRs +MTA +MTAs +MTU +MTUs +Maistra +Matrox +Mattermost +Maven +Mbit +Mbp +Mbps +Mechdyne +Mellanox +Memcheck +Metallb +Microarchitectural +Microsoft +Miganalytic +Minicpm +Minikube +Minio +Minishift +Mirantis +Misconfiguring +Mixtral +Mockito +Monck +Moncks +Mpp +Mpps +Multiarch +Multicontainer +Multihoming +Multimesh +Multinamespace +Myricom +NAD +NADs +NAT +NATs +NDN +NDNs +NF +NFs +NIC +NICs +NLB +NLBs +NMI +NMIs +NNCP +NNCPs +NPU +NPUs +NUMA +NUMAs +NVDIMM +NVDIMMs +Nagios +Nagle +Narayana +Nehalem +Neoverse +Netfilter +Netlify +Netronome +Netty +Netware +Newdoc +Ningxia +Nmap +Nonencrypted +Nonmaskable +Nooba +Noobaa +Normalspoke +Novell +Nvidia +OCI +OCPU +OCPUs +OEM +OEMs +OID +OIDs +OLM +OLMs +OS +OSes +OSD +OSDs +OTP +OTPs +OU +OUs +OV +OVs +Octeon +Offlining +Oki +Okta +Omnikey +Openflow +Operand +Operands +Opteron +Osasco +Overlayf +Overlayfs +Ovis +Ovmf +Oxmox +PAM +PAMs +PBN +PBNs +PCR +PCRs +PD +PDs +PDB +PDBs +PDF +PDFs +PDMA +PDMAs +PF +PFs +PHC +PHCs +PHP +PMDA +PMDAs +PNA +PNAs +PNF +PNFs +PPK +PPKs +PSAT +PSATs +PSK +PSKs +PTE +PTEs +PUK +PUKs +PV +PVs +Pagerduty +Pagure +Pak +Paks +Parameterizing +Pathing +Patternfly +Paulo +Pebibyte +Pebibytes +Pensando +Perc +Petitboot +Pixmap +Pixmaps +Podified +Poppler +Posix +Powerpath +Precheck +Prechecks +Promtail +Proxyless +QAT +QATs +Qlogic +Quadlet +Quadlets +Quadro +Quarkiverse +Quarkus +Quiltflower +Qute +Qwen +RA +RAs +RBAC +RBACs +RCODE +RCODEs +RDBMS +RDBMSes +RHEL +RPC +RPCs +RPZ +RPZes +RSCN +RSCNs +RTT +RTTs +RU +RUs +RUV +RUVs +RWN +RWNs +Radeon +Rado +Rados +Redis +Redistributions +Rekor +Reranker +Resizeable +Ricoh +Rmt +Rockhopper +Rollup +Rubygem +Rubygems +SA +SAs +SCC +SCCs +SCM +SCP +SCPs +SDK +SDKs +SHA +SHAs +SID +SIDs +SKU +SKUs +SLO +SLOs +SMCP +SMCPs +SME +SMEs +SMI +SMIs +SNI +SNIs +SPN +SPNs +SRE +SREs +SSD +SSDs +SSH +SSHes +SSSD +SVG +SVID +SVIDs +Sakila +Savin +Seagate +Searchguard +Semeru +Senao +Sensu +Shadowman +Silicom +Sindhu +Skyhawk +Skylake +Slirp +Slurm +Smartcard +Snyk +Softlockup +Solarflare +Solaris +Sonatype +Sorce +Spanmetric +Spanmetrics +Splitscreen +Spotify +Springboot +Stackdriver +Stackless +Stratis +Stunnel +Suchow +Supermicro +Symfony +Sysroot +Systemtap +TD +TDs +TGT +TGTs +THP +THPs +TLB +TLBs +TLD +TLDs +TPM +TPMs +TPU +TPUs +TTL +TTLs +Tebibyte +Tebibytes +Tekton +Telekom +Templateinstance +Templateinstances +Temurin +Tencent +Tensorflow +Thanos +Themisto +Thorntail +Threema +Tibco +Tk +Toolbx +Traefik +Trainium +Transpiler +Trie +Tries +Turbostat +Twofish +Tx +Tyagi +UBI +UBIs +UDN +UDNs +UID +UPG +UPGs +UPN +UPNs +URI +URIs +URL +URLs +USB +Uber +Unapplying +Unary +Uncaching +Unlinking +Unmarshaler +Unmarshalers +Unprocessable +Userland +VCN +VCNs +VF +VFs +VG +VGs +VGW +VGWs +VHD +VHDs +VID +VIDs +VLAN +VLANs +VM +VMs +VMA +VMAs +VMDK +VMDKs +VMI +VMIs +VNF +VNFs +VPA +VPAs +VPC +VPCs +VPN +VPNs +VPU +VPUs +VRF +VRFs +VSB +VSBs +VSI +VSIs +VSL +VSLs +VSR +VSRs +VXLAN +VXLANs +Vale +Valkey +Venafi +Venix +Viaq +Viewbilling +Volsync +Voxtral +Vxlan +WWID +WWIDs +WWN +WWNs +Wacom +Webpack +Wildfly +Winsync +Woopra +Xen +Xeon +Xming +Xnest +Xorg +Xserver +Xwayland +Yana +Yeoman +Yubikey +Zhuyin +Zipkin +Zlib +Zowe +Zstandard +aacraid +accessor +ack +acpi +acpid +actioned +adata +adcli +addon +addons +adm +adminnetworkpolicy +adminnetworkpolicies +adminpolicybasedexternalroute +adminpolicybasedexternalroutes +adoc +aduser +advancecomp +aescbc +agentless +aio +airgapped +akonadi +alacarte +alertingrule +alertingrules +alertmanager +alertmanagers +alertmanagerconfig +alertmanagerconfigs +alertrelabelconfig +alertrelabelconfigs +allowlist +allowlists +allowlisted +allowlisting +alwaysprompt +amd +annobin +annocheck +anonymized +answerfile +aoe +apc +apic +apiguardian +apirequestcount +apirequestcounts +apiserver +apiservers +apisonator +approver +approvers +architected +archivable +arcmsr +aresource +arg +args +argo +argocd +arptable +arptables +asciibinder +asciidoc +asciidoctor +assumeno +assumeyes +async +ata +atime +attacher +attestor +attestors +attica +audiofile +auditability +auditable +auditctl +auditd +augenrule +augenrules +ausearch +authconfig +authd +authfile +authfiles +authorizer +authselect +autoactivated +autoactivation +autoconfig +autoconfiguration +autoconfigure +autodetected +autodiscover +autodiscovers +autodiscovering +autodiscovery +autof +autofs +autofilled +autogenerate +autogroup +autogroups +autoinstall +autoinstrumentation +autolink +automapper +automation +automations +automember +automembership +automount +autonumber +autopart +autopopulate +autopopulates +autopopulated +autoreboot +autorelabel +autorid +autosavet +autosavets +autoscale +autoscaled +autoscaler +autoscalers +autoscaling +autostart +autosuspend +autotl +autotls +avc +aws +az +azp +backend +backends +backfill +backfills +backfilled +backfilling +backhaul +backlink +backlinks +backoff +backport +backports +backported +backporting +backpressure +backstore +backtrace +balancer +balancers +baref +barefs +baremetal +baremetalhost +baremetalhosts +baseband +baselineadminnetworkpolicy +baselineadminnetworkpolicies +basename +batcher +baz +bcel +bcrypt +bcull +bello +bfa +bfd +bgp +bindable +bindep +bindtype +binutil +binutils +bitmask +bitrate +bitrates +bitwise +blackbox +blkid +blocklisted +blocklisting +blockmap +bltk +bluedevil +bluetooth +bluez +bmap +bmceventsubscription +bmceventsubscriptions +bmh +bogo +bookinfo +bool +boolean +bootable +bootc +bootdev +bootimage +bootimages +bootkit +bootkits +bootlist +bootloader +bootmap +bootup +bootupd +borrowable +bot +bots +bottlenecked +bpf +bpfman +bpftool +bpftrace +breakpoint +breakpoints +brltty +broadcasted +brun +bsdcpio +bsfm +bsi +bson +bsonobjectid +bstop +btn +btree +buddyinfo +bugfix +buildah +buildahs +buildconfig +buildhost +buildroot +builtin +builtins +burstable +busybox +bwidget +byobu +bzr +cachedir +cachefilesd +cachepool +cacher +cainjector +callout +callouts +camelcased +canonicalization +canonicalized +canonicalizing +capturegroup +capturegroups +catalogd +catalogsource +catalogsources +catchpoint +catchpoints +ccis +ccises +ccoctl +cdrom +cdrskin +cel +ceph +cephfs +certf +certfs +certmonger +certutil +cgroup +cgroups +chan +che +checkpointed +checkpointing +checkresult +checkresults +checksu +checksumming +chipset +chipsets +chkconfig +chrony +chroot +chrooting +chrt +chunklimitsize +ci +cib +cidr +cidrs +ciphertext +ciphertexts +classful +classload +classloads +classloaded +classloader +classloading +classpath +clearpart +cleartext +cli +clickjacking +clientid +clocksource +cloudcredential +cloudcredentials +cloudformation +cloudprivateipconfig +cloudprivateipconfigs +cloudwatch +clusterautoscaler +clusterautoscalers +clustercatalog +clustercatalogs +clustercsidriver +clustercsidrivers +clusterextension +clusterextensions +clusterextensionrevision +clusterextensionrevisions +clusterimagepolicy +clusterimagepolicies +clusterip +clusterips +clusterlogforwarder +clusterlogforwarders +clusterlogging +clusterloggings +clusteroperator +clusteroperators +clusterresourcequota +clusterresourcequotas +clusterrole +clusterroles +clusterrolebinding +clusterrolebindings +clusterserviceversion +clusterserviceversions +clustertask +clustertasks +clustertriggerbinding +clustertriggerbindings +clusteruserdefinednetwork +clusteruserdefinednetworks +clusterversion +clusterversions +cmd +cmds +cmdline +cn +cnic +cnt +cobertura +codeblock +codec +codecs +codemodel +coderay +cohabitating +colocate +colocated +colocating +colocation +commandline +compat +composability +composable +composef +composefs +conditionalize +conditionalized +conditionalizing +config +configs +configmap +configmaps +conformant +conmon +conmons +connmark +consoleclidownload +consoleclidownloads +consoleexternalloglink +consoleexternalloglinks +consolelink +consolelinks +consolenotification +consolenotifications +consoleplugin +consoleplugins +consolequickstart +consolequickstarts +consolesample +consolesamples +consoleyamlsample +consoleyamlsamples +container +containers +containerd +containerruntime +containerruntimes +containerruntimeconfig +containerruntimeconfigs +controllerconfig +controllerconfigs +controlplanemachineset +controlplanemachinesets +cooldown +coolkey +coredumpctl +corequisite +coreutil +coreutils +corosync +cpptest +cppunit +cpu +cpus +cpufreq +cpuid +cpupower +cpuset +cpusets +crashloopback +crashloopbacks +crashlooping +createfile +createrepo +credentialsrequest +credentialsrequests +crio +crl +crls +cron +cronjob +cronjobs +crontab +crun +crypto +cryptoprocessor +cryptsetup +crypttab +cs +csi +csisnapshotcontroller +csisnapshotcontrollers +cstate +ctc +ctdb +cui +custodia +customisable +customizer +cutover +cv +cvsp +cvsps +cyberattack +cybercrime +cybersecurity +cyclictest +cypher +cyphers +czvf +daemon +daemonless +daemonset +daemonsets +dagre +dapl +dasd +dasdfmt +datacenter +datacenters +dataclass +dataclasses +datafile +datagram +dataimage +dataimages +dataloader +dataloaders +datamover +datapoint +datapoints +datasource +datastore +datastores +datastream +datavolume +datestamped +datetime +dax +dbu +dbus +dbx +dconf +deallocate +deallocated +deallocating +deallocation +deauthenticate +deauthorize +debugf +debugfs +debuggability +debuginfo +debuglevel +debugmode +debugsource +decapsulation +declarative +declaratively +decompiler +deconflict +dedupe +deduplicate +deduplicates +deduplicated +deduplicating +deduplication +defragment +defragments +defragmentation +defragmented +defragmenting +dejagnu +deltaiso +deltarpm +demangling +demodularized +demouser +dentries +dentry +denylist +deploy +deployer +deployers +deploymentconfig +deploymentconfigs +depmod +deprovision +deprovisioned +deprovisioning +depsolve +depsolving +dequeue +dequeues +dequeuing +dereference +dereferenced +dereferencing +deschedule +deschedules +descheduled +descheduler +descheduling +descriptor +deserializable +deserialization +deserialize +deserializes +deserialized +deserializer +deserializing +destructor +destructors +desynchronization +desynchronize +desynchronizes +desynchronized +desynchronizing +dev +devcatalog +devfile +devfiles +devicevolume +devlink +devlinks +devnode +dex +df +dgst +dhclient +dhcp +dhcpd +dialog +dialogs +dict +dicts +disallowment +discoverability +disklabel +disklabels +diskless +diskmaker +diskspace +diskspacecheck +disruptable +distinguisher +distinguishers +distro +distros +dmesg +dmraid +dn +dns +dnf +dnsmasq +dnsrecord +dnsrecords +dnstap +dockerfile +dockerfiles +docstore +docstring +docstrings +domainname +domainnames +donut +dosfstool +dosfstools +dotnet +downloader +downsampled +downsampling +downscaling +downstream +downstreams +downstreamed +downstreaming +downtime +downtimes +dp +dpdk +dracut +driverctl +driverdisk +driverless +dropbox +drpm +drpmsync +dscp +dstat +dstrct +dtdinst +dualstack +dumpet +dumpxml +dvd +dvgrab +dvice +dvices +dwarf +dwarves +dwz +easymock +eb +ebs +ebpf +ebtable +ebtables +ecj +editability +efax +efibootmgr +egressfirewall +egressfirewalls +egressip +egressips +egressqos +egressqoses +egressrouter +egressrouters +egressservice +egressservices +ekiga +elasticloadbalancing +elasticsearch +elfutil +elfutils +elink +elinks +emptydir +enablegroup +enablegroups +enablement +encoding +endian +endif +englightbox +enlightbox +enlightenment +enlightenments +enqueue +enqueues +enqueued +enricher +enum +env +envs +eod +eport +eports +epydoc +errorlevel +espeak +etcd +etcds +etcdctl +ethernet +ethtool +etype +eu +eus +eula +eventlistener +eventlisteners +evmc +evmcs +exactarchlist +examplepath +excludable +excludelist +exe +exec +execstack +existingfile +expander +expanders +expectk +expiration +exposable +exposal +expr +externalname +extlinux +extranet +extrapartition +faceplate +faceplates +fadump +failback +failover +fakeroot +fapolicy +fapolicyd +farstream +fastpath +favicon +favicons +fc +fcntl +fcoe +fcull +fdasd +fdatasync +fdisk +featuregate +featuregates +featureset +fedc +fedcb +fielddata +fieldset +fieldsets +filebench +fileio +filelist +filepath +filepath +filepaths +filesaving +fileshare +filestore +filesystem +filesystems +finalizer +finalizers +findability +finetune +finetunes +finetuned +finetuner +finetuning +fio +fip +fips +firefox +firewalld +firewalling +firmware +firmwares +firmwareschema +firmwareschemas +firstboot +firstimage +flamegraph +flamegraphs +flocker +flowlog +flowlogs +flowtable +flowtables +fluentd +fluentds +flushinterval +flushmode +flushthreadcount +fonttool +fonttools +footnoteref +freerdp +fro +fros +fromon +fromui +fronthaul +frr +frun +fsck +fsf +fsid +fstab +fstop +fstrm +fstype +fsync +ftrace +fullname +fullpack +func +fuseiso +futex +gatewayclass +gatewayclasses +gbps +gc +gcab +gcc +gce +gcloud +gcloudcompute +gcp +gdb +gdbm +gdm +gedit +genpkey +geo +geoclue +geospatial +getdent +getsubid +ghostscript +gibibyte +gibibyte +gibibytes +giga +github +gitlab +gitop +gitops +glew +glibc +glock +glocks +glstat +glstats +glusterfs +gmp +gnote +godoc +gofmt +golang +golangs +goroutine +goroutines +govc +gperftool +gperftools +gpgcakey +gpgcheck +gpgkey +gpsd +gpspipe +gpt +gradle +grafana +grafanas +grantlee +granularities +granularity +grayscale +greenboot +groupofname +groupofnames +grouprestriction +grouprestrictions +growpart +grpc +gsetting +gsettings +gssntlmssp +gstreamer +gsutil +gucharmap +guestf +guestfs +gutenprint +gvncpulse +gw +gwenview +gz +gzip +gzipped +hadamard +hamcrest +hardcode +hardcoded +hardcoding +harddrive +hardlink +hardlinks +hardlockup +hardwaredata +hashbang +hashbangs +hashmap +hawkey +hcp +healthcheck +healthz +heatmap +heatmap +heatmaps +helmchartrepository +helmchartrepositories +helpdesk +heredoc +heredocs +heterogeneous +hexchat +hexcolor +hexcolors +hextet +hextets +highport +hipaa +hivex +hmaccalc +hmc +hoc +hookpoint +hookpoint +hookpoints +hostapd +hostcluster +hostclusters +hostfile +hostfirmwarecomponent +hostfirmwarecomponents +hostfirmwaresetting +hostfirmwaresettings +hostgroup +hostgroups +hostname +hostnames +hostpath +hostupdatepolicy +hostupdatepolicies +hostwithnatswitch +hotplug +hotspot +hotspots +hpij +hpijs +hplip +hpsa +hptiop +href +hsakmt +hsqldb +htdig +html +htmltest +htpasswd +http +httpd +httproute +httproutes +https +hugepage +hugepages +hwlatdetect +hyperconverged +hyperdisk +hyperscale +hyperscaler +hyperthreading +iamserviceaccount +iamserviceaccounts +ibmcloud +ibmcos +iburst +ibutil +ibutils +icsp +idempotence +idmap +idmclient +idmgroup +idmserver +idmuser +idoverridegroup +idoverrideuser +idp +idps +idview +ifcfg +ifconfig +ifdef +ifeval +ifndef +ignoredisk +ilo +imagedigestmirrorset +imagedigestmirrorsets +imagepolicy +imagepolicies +imageregistry +imageset +imagestream +imagestreams +imagestreamimage +imagestreamimages +imagestreamtag +imagestreamtags +imagetagmirrorset +imagetagmirrorsets +imake +img +immediate +impactful +imsetting +imsettings +includepkg +includepkgs +incore +inetorgperson +inetuser +inference +inferences +inferenced +inferencing +infiniband +ing +ingester +ingesters +ingresscontroller +ingresscontrollers +ingressgateway +ingressgateways +ini +inis +iniparser +initialism +initialisms +initializer +initializers +initio +initramf +initramfs +initrd +initscript +initscripts +inline +inline +inlines +inlined +inode +inplace +installonlypkg +installonlypkgs +installplan +installplans +installrootkeep +instancetype +instantiator +instantiators +instruction +instructions +instrumentation +instrumentations +intel +interdomain +interoperate +interoperating +intracluster +intranode +intrapartition +intrarecord +intraservice +intrasystem +invalidation +invalidations +invocable +iok +iopen +iostat +ip +ipa +ipaclient +ipaclients +ipactl +ipaddres +ipaddreses +ipaddress +ipaddresses +ipaddressclaim +ipaddressclaims +ipadnsconfig +ipagroup +ipahost +ipaidp +ipam +ipaobject +ipaserver +ipasshuser +ipausergroup +ipc +ipfix +ipi +ipmievd +ipmitool +ippool +ippools +iproute +ipsec +ipsilon +iptable +iptables +iputil +iputils +ipvlan +iqn +iqns +irdma +irq +irqbalance +irqsoff +irreproducibility +irssi +isbn +isci +iscsi +iscsiadm +iscsiname +iso +isos +isorelax +iss +istio +istios +istioctl +istiod +istiods +jabberpy +jackson +jaf +jandex +jarjar +javac +javamail +javascript +jaxen +jbigkit +jctool +jctools +jdata +jdom +jemalloc +jigawatt +jigawatts +jing +jira +jmc +jna +joesec +journal +journals +journalctl +journald +journaled +journaling +jq +js +jsmith +json +juk +junit +jvm +kaccessible +kactivitie +kactivities +kafka +kamera +kate +kbd +kcalc +kcharselect +kcolorchooser +kcoloredit +kdeaccessibility +kdeadmin +kdeartwork +kdegraphic +kdegraphics +kdelib +kdelibs +kdemultimedia +kdenetwork +kdepim +kdepimlib +kdepimlibs +kdesdk +kdeutil +kdeutils +kdf +kdump +keda +keepalive +keepalived +keepcache +kepler +kerberize +kerberized +kerberos +kernelpkgname +kernelpkgnames +kernelshark +kexec +keycloak +keycloaks +keyfile +keyfiles +keyless +keylime +keymap +keymaps +keypair +keypairs +keyphrase +keyring +keyrings +keyserver +keyslot +keyspace +keystore +keytab +keytabs +kgamma +kgpg +khotkey +khotkeys +kiali +kibana +kickstart +kickstarts +kiconedit +kinfocenter +kinit +klist +klog +klusterlet +kmag +kmenuedit +kmix +kmod +kmods +knative +knet +knowledgebase +kolourpaint +konkretcmpi +konnectivity +konsole +kpatch +kprobe +kprobes +krbprincipalaux +krbticketpolicyaux +kruler +ksaneplugin +kscreen +ksdevice +ksmd +ksnapshot +ksonnet +ksshaskpas +ksshaskpases +ksysguard +ksysguardd +ktimer +kube +kubeadmin +kubeconfig +kubectl +kubedns +kubelet +kubelets +kubeletconfig +kubeproxy +kubernetes +kubernetesenv +kubevirt +kustomization +kustomize +kvm +kwallet +kwin +kwrite +kxml +langpack +langpacks +latencytop +latrace +layernorm +lc +ld +ldap +ldapmodify +ldapsearch +ldconfig +ldns +leapp +leptonica +leveloffset +leveloffsets +lftp +libaio +libappindicator +libbabeltrace +libbluedevil +libbonobo +libbonoboui +libbpf +libc +libchewing +libcmpiutil +libcrypto +libdb +libdbi +libdnf +libecpg +libee +libesmtp +libfdt +libg +libgs +libgccjit +libgcrypt +libgepub +libgnat +libgnome +libgnomecanvas +libgnomeui +libgo +libgudev +libguestf +libguestfs +libgxim +libhangu +libhif +libibcommon +libibmad +libidn +libij +libijs +libindicator +libinput +libiodbc +libiscsi +libkcddb +libkcompactdisc +libkdcraw +libkipi +libkkc +libksane +libkscreen +libkworkspace +liblockfile +libmemcached +libmodulemd +libmsn +libmudflap +libmusicbrainz +libmx +libnbd +libnetapi +libnice +libnl +libnma +libnmstate +libnsl +libntlm +libnumbertext +libobjc +libofa +liboil +libomp +libpgtype +libpgtypes +libpinyin +libpmemcto +libpod +libpq +libpst +libpwquality +librados +librbd +libreoffice +libreswan +librt +librtk +librtkaio +libsecret +libsexy +libslirp +libssh +libssl +libtpm +libtpms +libtraceevent +libtracef +libtracefs +libtranslit +libunwind +liburing +libvirt +libvirtd +libwbclient +libwinpr +libwpe +libwvstream +libwvstreams +libxcrypt +libxdp +libxmlb +libzapojit +libzhuyin +libzstd +licensor +lifecycled +lightbox +linearization +linearize +linux +linuxptp +liquibase +liveimg +liveness +lld +lldb +llvm +lmdb +loadbalancer +loadbalancers +loadbalancing +localnet +localssd +lockdown +lockdowns +lockfile +lockless +lockspace +logcollector +logfile +logicalvolume +logicalvolumes +loginuid +logrotate +logvol +loki +lokistack +lookaside +lookback +lookup +lookups +loopback +lowercase +lowercases +lowercased +lpadmin +lpar +lpfc +lshw +lsname +lstopo +ltrace +lua +lucene +luk +luks +luksmeta +lun +luns +lvm +machineautoscaler +machineautoscalers +machinehealthcheck +machinehealthchecks +machineosconfig +machineosconfigs +machinepool +machinepools +machineset +machinesets +macrostructure +macvlan +macvtap +madvise +mainboard +makedumpfile +makefile +makefiles +manpage +mariabackup +maskable +matcher +matchers +matchrule +matrixes +maxpoll +mcollective +md +mdadm +mddownloadpolicy +mdev +mdevctl +mdpolicy +mebibytes +mediacheck +memberlist +membermanager +memcache +memcg +memnode +memstick +memstomp +memstrack +mergeable +metacharacter +metacharacters +metaclass +metafile +metalink +metamodel +metapackage +metatable +mgetty +mgmt +mib +microarchitecture +microarchitectures +microdnf +micropipenv +microsegmentation +microservice +microservices +middleware +midhaul +migplan +migr +migratable +migrationtool +migrationtools +migstorage +miimon +millicore +millicores +millicpu +mimetype +min +minicourse +minidisk +minimalistic +minizip +minpoll +minrate +mirrorlist +misconfiguration +misconfigurations +misconfigured +mitigation +mitigations +mixin +mixins +mkbootdisk +mkf +mkfs +mkinitrd +mmc +mng +mntpoint +modesetting +modrdn +modularization +modularize +modulefile +modulefiles +mokutil +monorepo +monorepos +monospace +monospaced +monthday +monthdays +mountd +mountpoint +mountpoints +mountstat +mountstats +mpage +mpdecimal +mpich +mpirun +mptbase +mptcpd +mptcpize +mptctl +mptsa +mptsas +mptscsih +mptspi +msbuild +msdo +msdos +msg +mssql +mthca +mtime +mtl +mtls +mtu +multibyte +multicast +multicloud +multicluster +multifactor +multihop +multihost +multilib +multiline +multimodal +multinode +multipath +multipathed +multipathing +multipoint +multiport +multiprogram +multiprotocol +multiqueue +multischema +multisite +multitable +multitenancy +multitenant +multithread +multithreading +multitier +multitiered +multiuser +multivendor +multizone +multu +multus +mutex +mutexes +mvsa +mvsas +mvumi +myapp +mydestination +mydomain +myecho +mylv +mynetwork +mynetworks +myproject +mysql +mysqldump +mythinsnap +myubi +myvdo +myvg +na +nameserver +nameservers +namespace +namespaces +namespaced +namespacing +nano +nanos +nasm +nbctl +nbdb +nbdfuse +ndctl +nekohtml +nestedgroup +netavark +netboot +netcf +netclass +netclasses +netconsole +netdev +netdevice +netgroup +netgroups +netlink +netmask +netobserv +newdisk +newecho +newrdn +nf +nfp +nfsnobody +nfsometer +nfstest +nftable +nftables +nginx +nic +nics +nicpf +nicvf +nispor +nlb +nlt +nm +nmcli +nmstate +nmstatectl +nmtui +noarch +nodeagent +nodejs +nodename +nodenames +nodeport +nodeselector +nodeselectors +nodesliceippool +nodesliceippools +nodeslicepool +nodeslicepools +noexec +nohotcorner +nohz +nonauthoritative +nondefault +nondestruct +nonexpiring +nonheap +noninteractive +nonlocal +nonoverlapping +nonpaired +nonposix +nonrecovery +nonrecursive +nonrenewal +nonroot +nonsystem +nop +northd +nosmt +nosniff +notchecked +npm +npth +nsenter +nslcd +nsswitch +nsupdate +nt +ntfs +ntlm +ntlmssp +ntp +ntpd +ntpdate +ntpdc +ntpq +ntpstat +num +numactl +numaresourcesoperator +numaresourcesoperators +numastat +numatop +numpy +nutanix +nuxwdog +nvdimm +nvme +nvmetcli +oauth +oauthaccesstoken +oauthaccesstokens +oauthauthorizetoken +oauthauthorizetokens +oauthclient +oauthclients +obexd +oc +ocaml +oci +ocm +ocp +ocsp +odc +odo +offboard +offboards +offboarded +offboarding +offlined +oidc +okindf +okular +olm +olmconfig +olmconfigs +omnichannel +onboard +onboards +onboarded +onboarding +oneshot +onlining +opae +opencc +opencv +openid +openjade +openjpeg +openlmi +openmpi +openobex +opensc +openscap +openshiftapiserver +openshiftapiservers +openshiftcontrollermanager +openshiftcontrollermanagers +opensp +openssl +openstack +openstacks +openvswitch +oper +operator +operatorcondition +operatorconditions +operatorgroup +operatorgroups +operatorpki +operatorpkis +oplock +opm +oprofile +optipng +organizationalperson +ortp +osad +osbuild +osd +oslat +osname +ospp +ossm +osst +ostoy +ostree +ostreecontainer +ostreesetup +otlp +outfile +overcommit +overcommitted +overcommitting +overflowaction +overlappingrangeipreservation +overlappingrangeipreservations +overprovisioned +overprovisioning +overridable +overriden +overstrike +overutilized +overvoting +overwritable +ovirt +ovn +packagemanifest +packageserver +pagecache +papi +parallelization +param +params +parameterization +paravirtual +paravirtualization +paravirtualized +parksmap +parm +parsable +parseable +passdb +passivetex +passt +passthrough +passwd +passwordless +pata +pathgroup +pathname +pathnames +pc +pcm +pcp +pcre +pcsd +pello +perf +performanceprofile +performanceprofiles +performant +perl +perltidy +persistdir +persistentvolumeclaim +persistentvolumeclaims +pexpect +pgaudit +php +pid +pingable +pinnedimageset +pinnedimagesets +pipelined +pipelinerun +pipelineruns +pipelining +pixtral +pkc +pkcs +pkey +pkgconfig +pkinit +plaintext +pluggable +pluginconfpath +pluginpath +pmc +pmcd +pmchart +pmcraid +pmem +pminfo +pmlogconf +pmlogger +pmproxy +pmrep +pmserie +pmseries +pmstore +pngcrush +pngnq +po +poddisruptionbudget +poddisruptionbudgets +podman +podmonitor +podmonitors +podnetworkconnectivitycheck +podnetworkconnectivitychecks +polkit +polling +pollings +polyinstantiated +polyinstantiation +populator +populators +portforward +portgroup +portmapper +portworx +postedit +postedits +postedited +postediting +posteditor +postgre +postgres +postgresql +postinstall +postinstallation +postoperation +postprocessing +postqueue +postrequisite +poweroff +powersave +powersaving +powershell +powertop +powervs +ppd +ppds +pprof +pragma +pre +preallocate +preallocates +preallocated +preallocating +preallocation +preauthentication +preboot +prebuild +precache +precaches +precached +precaching +precompile +precompiles +precompiled +precompute +precomputing +preconfiguration +preconfigure +preconfigures +preconfigured +preconfiguring +preconnect +preconnects +precreate +preemptible +preemption +preemptions +preemptirqsoff +preemptoff +preenrollment +prefetch +prefill +prefork +preformat +preformats +preformatted +preformatting +pregenerate +pregenerates +pregenerated +pregenerating +pregeneration +preinstall +preinstallation +preinstalling +prelink +preload +preloaded +preloading +preoperational +prepend +prepend +prepends +prepended +prepending +prepopulate +prepopulated +preprocess +preprocessor +preprovisioning +preprovisioningimage +preprovisioningimages +prereq +prerequired +prerollback +preruntime +presigned +pretrained +preupgrade +printk +prioritizer +prioritizers +priorityclass +priorityclasses +privatelink +prober +probers +productization +productize +productizes +productized +productizing +productpage +profileparser +profiler +projecthelmchartrepository +projecthelmchartrepositories +prometheus +prometheusrule +prometheusrules +promql +protobuf +provisionator +provisioner +provisioners +proxied +proxying +psample +pscsi +pseudocode +pseudorandom +pseudotext +psql +psutil +psutils +pth +pthread +pthreads +ptlib +pulldown +pullspec +pullthrough +pushpull +pvc +pvck +pvcreate +pvpanic +pxelinux +qatengine +qatlib +qatzip +qdisc +qdiscs +qdmanage +qdox +qdstat +qeth +qimageblitz +qjson +qlcnic +qlge +qnetd +qos +quantizable +quantization +quantize +quantizes +quantized +quantizer +quantizing +querier +queryable +querylog +quiescing +quobyte +quotacheck +quotasync +qxl +racadm +rados +radvd +raleigh +ramdisk +rangeallocation +rangeallocations +rangesize +rasdaemon +rase +rawip +rbac +rbd +rc +rd +rdate +rdist +reachability +reactively +readahead +readlinelimit +readonly +realmd +realtime +reauthenticate +reauthenticates +reauthenticated +reauthenticating +reauthentication +rebalance +rebalances +rebalanced +rebalancer +rebalancing +rebase +rebases +rebased +rebasing +recertification +recertifications +rechunk +rechunking +recommender +recommenders +reconciler +reconcilers +recordset +recursing +recursor +recursors +redcircle +redeployment +redeployments +redi +redis +redirection +redirections +redirector +redirectors +redistributable +reenable +reenabled +reenables +reenabling +reencrypt +reencrypted +reencrypting +reenlightenment +reentrant +referenceable +referencegrant +referencegrants +reflink +reflinked +reformat +reformats +refreshable +regedit +regionalized +reimage +reimaging +reimplementation +reindex +reindexes +reindexed +reindexer +reindexing +reinitialization +reinitialize +reinitializes +reinitializing +reinstall +reinstalls +reinstallation +rekey +rekeyed +rekeying +relabeling +relabelings +relaxngcc +releasever +reloadable +relocation +relocations +remediation +remediations +remediator +remirror +remirroring +remotebaud +remoting +remountable +renderedmachineconfig +renderedmachineconfigs +replaceable +replaceables +replicaset +replicasets +repo +repos +repodata +repositoryid +reposync +reprovision +reprovisioned +reprovisioning +repurpose +reqpart +requestor +requeue +requeues +requeued +rescan +rescanning +resctl +reshard +reshards +resharded +resharder +resharding +resizable +resizef +resizefs +resizer +resnet +resourcegroupstaggingapi +responder +responders +resteasy +restic +restorecon +resultserver +resync +resyncs +resynced +resyncing +retrigger +retrymaxinterval +retrytimeout +retrytype +retrywait +reusability +revisioned +rfc +rfkill +rgb +rgbcolor +rgrp +rh +rhc +rhcd +rhel +rhev +rhncfg +rhnpush +rhscl +rhsm +rkt +rngom +ro +rolebinding +rolebindings +rolebindingrestriction +rolebindingrestrictions +rollout +rollouts +rollup +rollups +rootf +rootfs +rootful +rootless +rootpw +rosa +roundrobin +roundtable +roundtables +routable +routing +routings +rpc +rpcbind +rpcclient +rpcgen +rpm +rpms +rpmnew +rpmsave +rpmverbosity +rsh +rshared +rshim +rsize +rslave +rsync +rsyslog +rtcdata +rtcheck +rtctl +rteval +rtla +rulebook +ruleset +runbook +runbooks +runc +runcmd +runlabel +runlabels +runlevel +runlevels +runpath +runtime +runtimes +ruser +rusers +rustfmt +rw +rwho +rwx +rwxrwxrwx +rx +sadc +sadump +safetensor +safetensors +sameorigin +samepage +sandboxed +sandboxing +sanlock +sapconf +sar +satisfiability +saxon +sbc +sbd +sbt +sca +scaledown +scaler +scalers +scannotation +scap +scatterchart +sched +schedulability +schedulable +scheduler +scipy +scon +scons +scpio +scriptable +scriptlet +scriptlets +scrollbar +scsi +sctp +sda +sdk +sdparm +searchability +seccomp +secureboot +securitycontextconstraint +securitycontextconstraints +sed +selinux +semanage +semver +sendmail +serializable +serialization +serializer +serverless +serviceaccount +serviceaccounts +serviceaccountrestriction +serviceaccountrestrictions +servicemonitor +servicemonitors +servicequota +servlet +setgid +setter +setuid +setuptool +sevctl +sfc +sftp +sgabio +sgabios +sgc +shard +shards +sharded +sharding +shotwell +showback +showdupesfromrepo +showdupesfromrepos +shows +shufflesharding +sid +sidecarless +sigstore +sinked +sisu +siw +skipx +skopeo +sla +sm +smarthost +smb +smbcacl +smbcacls +smbclient +smbcontrol +smbpasswd +smbstatus +smbtar +smoothquant +smp +smtp +sn +snactor +snakeyaml +snapset +snapshotted +snapshotter +snapshotting +sntp +so +softdog +software +softwares +somelibrary +soname +sosreport +sosreports +sourcestat +sourcestats +sourcetype +sourcetypes +sox +spacebar +spamc +spamd +sparsification +sparsified +sparsify +sparsifies +sparsifying +speex +speexdsp +spindown +spinlock +spinlocks +splunk +spod +spyre +sql +sqlite +src +ss +sset +sshd +sshkey +sshpas +sshpases +sshpw +sslcacert +sslclientcert +sslclientkey +sslverify +sss +sssctl +sssd +st +stacktrace +stacktraces +stalld +startx +statefulness +statefulset +statefulsets +statelessly +stateroot +stateroots +statuspage +stderr +stdin +stdout +stex +stig +stimer +stonith +storage +storages +storageos +storagestate +storagestates +storageversionmigration +storageversionmigrations +strace +strided +strigi +strongimcv +su +subaddress +subcapacity +subcase +subcases +subchannel +subchannels +subchapter +subchapters +subcommand +subcommands +subcomponent +subcomponents +subcontainer +subcontainers +subdevice +subfield +subfields +subflow +subflows +subfolder +subfolders +subfunction +subid +subinterface +subkey +subkeys +sublayer +subline +submenu +submenus +subnet +subnets +subnetwork +subnetworks +suboption +subpackage +subpackages +subpage +subpath +subpaths +subphase +subphases +subpolicies +subpolicy +subprocessor +subprocessors +subprotocol +subresource +subresource +subresources +subsecond +substate +substep +substeps +substring +subtab +subtab +subtabs +subtest +subtests +subtree +subtrees +subuser +subusers +subvolume +subvolumes +subzone +subzones +sudo +sudoer +sudoers +suexec +suitererunner +superblock +superblocks +supercede +supercedes +superceded +supermin +superobject +superscripted +superset +svc +svgpart +svrcore +swappiness +switchandtwoguest +switchandtwoguests +swtpm +synchronizer +synchronizers +synic +syntax +syntaxes +syscall +syscalls +sysctl +sysctls +sysf +sysfs +syslinux +syslog +syslogd +sysprep +syspurpose +sysstat +system +systems +systemctl +systemd +tablespace +tablespaces +targetcli +targetd +tasklet +tasklets +taskrun +taskruns +tasks +taskset +tc +tcl +tclx +tcp +tcpdump +tcpstat +tdb +teamd +teardown +telco +telecom +template +templates +templated +templating +temporality +tera +tesseract +testguest +testhostgroup +testnqn +testparm +testpmd +testuser +texinfo +tftp +tftpd +th +thanos +thanosruler +thanosrulers +theia +themself +thermald +thinpool +thinvolume +threescale +thresholding +thunderbird +tickles +timedatectl +timedatex +timeflowend +timeflowstart +timeframe +timereceived +timerlat +timeseries +timeslice +timesource +timespace +timespan +timestamping +timesync +tini +tinycdb +tipc +tkinter +tkn +tl +tlbflush +tlog +tmpf +tmpfs +tmpfile +tmpfiles +tmux +tncfhh +tokenization +tokenizer +tokenizers +tolerations +toolchain +toolkit +toolkits +toolset +toolsets +tooltip +tooltips +topolvm +totallimitsize +touchpad +touchpads +traceback +tracepoint +tracepoints +trang +transactionally +transcode +transcoded +transcoding +treefile +triggerbinding +triggerbindings +triggertemplate +triggertemplates +trojan +trojans +truststore +tsdb +tsflag +tsflags +ttl +tty +tunable +tunables +tuned +tuneds +tuser +tz +ubi +ubxtool +udev +udftool +udftools +udica +udn +udp +uefi +uevent +uevents +ufshcd +ui +uid +uid +uids +ulimit +ulimit +ulimits +ultravisor +umask +umount +unallocate +uname +unapplied +unapply +unarchived +unassign +unassigns +unbootable +unbuffered +uncached +uncheck +uncomment +uncommented +uncommenting +unconfigure +unconfigures +unconfigured +uncordon +uncordons +uncordoned +uncordoning +uncore +undefining +undeploy +undeploying +undercloud +underrun +underutilizing +unencrypted +unenroll +unenrolls +unenrollment +unescaped +unexported +unformatted +unfragmented +unicast +unidled +unidling +unifdef +uninstallation +uninstrumented +unioned +unioning +uniquifier +unix +unlink +unlinks +unlocker +unmanage +unmanages +unmanaged +unmap +unmarshal +unmarshaling +unmarshalling +unmount +unmounts +unmounted +unmounting +unobfuscated +unoconv +unorthographic +unpackage +unpackages +unpackaged +unpadded +unparsable +unparseable +unpart +unpartitioned +unpatched +unpause +unpauses +unpaused +unpausing +unport +unports +unported +unporting +unprefixed +unprovisioned +unquiesce +unquiescing +unrecoverably +unreferenced +unregister +unregistering +unreplicated +unschedulable +unschedule +unscoped +unselect +unselects +unselecting +unset +unsets +unsetting +unshare +unstage +unstages +unstaged +unstaging +unsuspended +unsynchronized +untag +untampered +untarred +untrusted +unvalidated +unversioned +unwritable +unzoned +upcall +upcalls +updater +updaters +upgradability +upgradation +uplink +uploader +uprobe +uprobes +upsell +upsells +upselling +upsert +upsold +uri +uriparser +url +urls +usb +usb +usbs +usbguard +useradmin +useradmins +usercache +userdata +userdefinednetwork +userdefinednetworks +useridentitymapping +userns +userrestriction +userrestrictions +userroot +userspace +usr +ustr +util +utils +utilization +utilizations +utsname +uuid +uuids +valgrind +validator +vapic +varlink +vcenter +vcenters +vcluster +vclusters +vcpu +vcpus +vdb +vdo +vectorizer +velero +veleros +vendored +vendoring +vepa +verifier +vfat +vfio +vg +vgcfgrestore +vhost +victorops +viewfile +viewobj +vigra +vimrc +vinagre +viorng +viostor +virsh +virt +virtctl +virtinterfaced +virtio +virtiofs +virtnetworkd +virtnodedevd +virtnwfilterd +virtqemud +virtsecretd +virtstoraged +virtualize +virtualized +virtualizor +virtualmachine +vlan +vm +vmcore +vmdk +vmimport +vmlinuz +vmname +vmtoolsd +vn +vnc +vnet +volgroup +volumeattachment +volumeattachments +volumepopulator +volumepopulators +volumesnapshot +volumesnapshots +volumesnapshotclass +volumesnapshotclasses +volumesnapshotcontent +volumesnapshotcontents +vpc +vpindex +vrf +vsftpd +vsix +vsphere +vulkan +waagent +wakeup +walkthrough +walkthroughs +wasm +watchpoint +watchpoints +waypipe +wbinfo +webex +webhook +webhooks +webserver +webservers +websocket +websockets +wechat +wget +whitepaper +whoami +whois +wifi +winbind +wirelessly +wireshark +wordnet +wordpress +workqueue +workqueues +writeback +wsize +wsrep +wvdial +wwid +wwid +wwids +www +xattr +xchat +xclock +xconfig +xferstats +xfs +xfsdump +xfsrestore +xguest +xhost +xisdnload +xl +xlat +xml +xmlstarlet +xmltoman +xmvn +xsom +xstream +xth +xulrunner +xvattr +xxhash +xz +yaml +yara +zerombr +zfcp +zipl +znetconf +zsh +zstd +ztp + +# Words from RHDH testing feedback (PR #1002) +Atlassian +django +drupal +Dynatrace +genai +GenAI +Gerrit +implementor +jruby +Ollama +quickstart +quickstarts +rhdh +scaffolder +scaffolded +Scalprum +sideload +sideloaded +Sonataflow +streamable +techdoc +techdocs +todo +todos +upskill +Yq diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 70b3193c..dc5b1fcf 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -14,15 +14,18 @@ jobs: runs-on: ubuntu-latest permissions: actions: read - checks: read + checks: write # Changed to write so Reviewdog can create check runs contents: read - pull-requests: read + pull-requests: write # Changed to write so Reviewdog can post comments on the PR steps: - uses: actions/checkout@v4 + - name: Install Asciidoctor run: sudo apt-get install -y asciidoctor + - uses: errata-ai/vale-action@reviewdog with: + sync: true # <--- ADDED: Dynamically runs 'vale sync' on-the-fly before linting starts filter_mode: diff_context vale_flags: "--no-exit --minAlertLevel=error --glob=*.adoc" reporter: github-pr-review diff --git a/assemblies/cli-guide/assembly_analyzing-applications-using-profiles.adoc b/assemblies/cli-guide/assembly_analyzing-applications-using-profiles.adoc index 1cf3f7fb..ae072115 100644 --- a/assemblies/cli-guide/assembly_analyzing-applications-using-profiles.adoc +++ b/assemblies/cli-guide/assembly_analyzing-applications-using-profiles.adoc @@ -16,7 +16,7 @@ endif::[] :context: analyzing-apps-profiles [role="_abstract"] -As a Migrator, you can use profiles to run an application analysis in the {ProductShortName} {CLIName}. Profiles have standardized analysis configuration, scope of an analysis, and custom rules that you can reuse for multiple analyses of a local application. +As a Migrator, you can use profiles to run an application analysis in the {ProductShortName} {CLIName}. Profiles have standardized analysis configuration, scope of an analysis, and custom rules that you can reuse for multiple analyses of a local application. Before you run an analysis, you can use the {ProductShortName} {CLIName} to download the latest configuration through a secure or insecure connection to the Hub. diff --git a/assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc b/assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc index f70503c1..f0ec5e6b 100644 --- a/assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc +++ b/assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc @@ -22,7 +22,6 @@ You can perform the analysis in either of the following ways: * Select a supported language provider to run the analysis for. * Overwrite the existing supported language provider with your own unsupported language provider, and then run the analysis on it. - IMPORTANT: Analyzing applications written in languages other than Java is only possible in container mode. You can use the containerless CLI only for Java applications. diff --git a/assemblies/cli-guide/assembly_generating-assets.adoc b/assemblies/cli-guide/assembly_generating-assets.adoc index ae62a94b..1e0a9c2a 100644 --- a/assemblies/cli-guide/assembly_generating-assets.adoc +++ b/assemblies/cli-guide/assembly_generating-assets.adoc @@ -29,14 +29,17 @@ You can use the `discover` and `generate` commands in containerless mode to auto + The discovery manifest preserves the specifications found in the CF manifest. The specifications define the metadata, runtime, and platform configurations. -* Use the `generate` command to generate the deployment manifest for {ocp} deployments by using the discovery manifest. The deployment manifest is generated by using a templating engine, such as Helm, that converts the discovery manifest into a Kubernetes-native format. You can also use this command to generate non-Kubernetes manifests, such as a Dockerfile or a configuration file. +* Use the `generate` command to generate the deployment manifest for {ocp} deployments. You can use this command to generate the Kubernetes and non-Kubernetes manifests. + :FeatureName: Generating platform assets for application deployment [IMPORTANT] ==== [subs="attributes+"] -{FeatureName} is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA. +{FeatureName} is Developer Preview software only. Developer Preview software is not supported by Red{nbsp}Hat in any way and is not functionally complete or production-ready. Do not use Developer Preview software for production or business-critical workloads. Developer Preview software provides early access to upcoming product software in advance of its possible inclusion in a Red{nbsp}Hat product offering. Customers can use this software to test functionality and provide feedback during the development process. This software might not have any documentation, is subject to change or removal at any time, and has received limited testing. Red{nbsp}Hat might provide ways to submit feedback on Developer Preview software without an associated SLA. + +For more information about the support scope of Red{nbsp}Hat Developer Preview software, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope]. ==== :!FeatureName: @@ -47,7 +50,6 @@ Generating deployment assets has the following benefits: * Adhering to Kubernetes best practices when preparing the deployment manifest by using Helm templates. - include::topics/mta-cli/proc_generating-discovery-manifest.adoc[leveloffset=+1] include::topics/mta-cli/ref_discovery_manifest_sample.adoc[leveloffset=+1] diff --git a/assemblies/cli-guide/assembly_reference-material.adoc b/assemblies/cli-guide/assembly_reference-material.adoc index 7bf539eb..bffd69a0 100644 --- a/assemblies/cli-guide/assembly_reference-material.adoc +++ b/assemblies/cli-guide/assembly_reference-material.adoc @@ -31,7 +31,7 @@ include::assembly_rule-story-points.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* link:{mta-URL}/rules_development_guide/index[Rules Development Guide] +* link:{mta-URL}/html-single/configuring_and_using_rules_for_an_mta_analysis/index[Configuring and using rules for an MTA analysis] ifdef::parent-context-of-reference-material[:context: {parent-context-of-reference-material}] ifndef::parent-context-of-reference-material[:!context:] diff --git a/docs/topics/developer-lightspeed/assembly_configuring-dev-lightspeed-ide.adoc b/assemblies/developer-lightspeed-guide/assembly_configuring-dev-lightspeed-ide.adoc similarity index 50% rename from docs/topics/developer-lightspeed/assembly_configuring-dev-lightspeed-ide.adoc rename to assemblies/developer-lightspeed-guide/assembly_configuring-dev-lightspeed-ide.adoc index d73a179a..e9ab31a0 100644 --- a/docs/topics/developer-lightspeed/assembly_configuring-dev-lightspeed-ide.adoc +++ b/assemblies/developer-lightspeed-guide/assembly_configuring-dev-lightspeed-ide.adoc @@ -11,19 +11,21 @@ endif::[] ifdef::context[] [id="configuring-dev-lightspeed-ide_{context}"] endif::[] -= Using {ProductShortName} with Developer Lightspeed in IDE += Using {ProductShortName} with Developer Lightspeed in an IDE :context: configuring-dev-lightspeed-ide [role="_abstract"] -You must configure the following settings in {mta-dl-full}: +As a Migrator, you must configure the Visual Studio Code Integrated Development Environment (IDE) to use the {mta-dl-full} plugin to run application analyses and generate code resolution suggestions. + +You must configure the following settings in {mta-dl-plugin}: * Visual Studio Code IDE settings. -* Profile settings that provide context before you request a code fix for a particular application. +* Profile settings that give context before you request a code fix for a particular application. -include::proc_configuring-developer-lightspeed-ide-settings.adoc[leveloffset=+1] +include::topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc[leveloffset=+1] -include::proc_configuring-developer-profile-settings.adoc[leveloffset=+1] +include::topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc[leveloffset=+1] ifdef::parent-context-of-configuring-dev-lightspeed-ide[:context: {parent-context-of-configuring-dev-lightspeed-ide}] ifndef::parent-context-of-configuring-dev-lightspeed-ide[:!context:] diff --git a/docs/topics/developer-lightspeed/assembly_configuring_llm.adoc b/assemblies/developer-lightspeed-guide/assembly_configuring_llm.adoc similarity index 57% rename from docs/topics/developer-lightspeed/assembly_configuring_llm.adoc rename to assemblies/developer-lightspeed-guide/assembly_configuring_llm.adoc index 797c7344..80cbe2eb 100644 --- a/docs/topics/developer-lightspeed/assembly_configuring_llm.adoc +++ b/assemblies/developer-lightspeed-guide/assembly_configuring_llm.adoc @@ -17,9 +17,9 @@ endif::[] [role="_abstract"] {mta-dl-plugin} provides the large language model (LLM) with the contextual prompt, migration hints, and solved examples to generate suggestions for resolving issues identified in the current code. -{mta-dl-plugin} is designed to be model agnostic. It works with LLMs that are run in different environments (in local containers, as local AI, or as a shared service) to support analyzing Java applications in a wide range of scenarios. You can choose an LLM from well-known providers, local models that you run from Ollama or Podman desktop, and OpenAI API compatible models. +{mta-dl-plugin} is model agnostic. It works with LLMs that are run in different environments (in local containers, as local AI, or as a shared service) to support analyzing Java applications in a wide range of scenarios. You can choose an LLM from well-known providers, local models that you run from Ollama or Podman desktop, and OpenAI API compatible models. -The code fix suggestions produced to resolve issues detected through an analysis depend on the LLM's capabilities. +The code fix suggestions that the LLM produces to resolve issues from an analysis depend on the LLM's capabilities. You can run an LLM from the following generative AI providers: @@ -34,11 +34,11 @@ You can also run OpenAI API-compatible LLMs deployed as: * A service in your {ocp-name} AI cluster * Locally in the Podman AI Lab in your system. -include::con_llm-service-openshift-ai.adoc[leveloffset=+1] +include::topics/developer-lightspeed/con_llm-service-openshift-ai.adoc[leveloffset=+1] -include::ref_llm-provider-configurations.adoc[leveloffset=+1] +include::topics/developer-lightspeed/ref_llm-provider-configurations.adoc[leveloffset=+1] -include::proc_configuring-llm-podman-desktop.adoc[leveloffset=+1] +include::topics/developer-lightspeed/proc_configuring-llm-podman-desktop.adoc[leveloffset=+1] ifdef::parent-context-of-configuring-llm[:context: {parent-context-of-configuring-llm}] ifndef::parent-context-of-configuring-llm[:!context:] diff --git a/assemblies/developer-lightspeed-guide/assembly_getting-started.adoc b/assemblies/developer-lightspeed-guide/assembly_getting-started.adoc new file mode 100644 index 00000000..5eaad927 --- /dev/null +++ b/assemblies/developer-lightspeed-guide/assembly_getting-started.adoc @@ -0,0 +1,44 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2025-05-28 + +ifdef::context[:parent-context-of-getting-started: {context}] + +:_mod-docs-content-type: ASSEMBLY + +ifndef::context[] +[id="getting-started"] +endif::[] +ifdef::context[] +[id="getting-started_{context}"] +endif::[] += Getting started with {mta-dl-plugin} + +:context: getting-started + +[role="_abstract"] +You can view prerequisites, persistent volume requirements, installation, and workflows that help you to decide how you want to use the {mta-dl-full}. + +[NOTE] +==== +To get support for features in {mta-dl-plugin}, you require a Red Hat Advanced Developer Suite (RHADS) subscription. +==== + +include::topics/developer-lightspeed/con_prerequisites.adoc[leveloffset=+1] + +include::topics/developer-lightspeed/con_persistent-volumes.adoc[leveloffset=+1] + +include::topics/developer-lightspeed/con_installation.adoc[leveloffset=+1] + +include::topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc[leveloffset=+1] + +include::topics/developer-lightspeed/proc_tackle-llm-secret.adoc[leveloffset=+1] + +include::topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc[leveloffset=+1] + +include::topics/developer-lightspeed/ref_example-code-suggestion.adoc[leveloffset=+1] + + +ifdef::parent-context-of-getting-started[:context: {parent-context-of-getting-started}] +ifndef::parent-context-of-getting-started[:!context:] + +:!getting-started: \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/assembly_run-dev-lightspeed-analysis.adoc b/assemblies/developer-lightspeed-guide/assembly_run-dev-lightspeed-analysis.adoc similarity index 78% rename from docs/topics/developer-lightspeed/assembly_run-dev-lightspeed-analysis.adoc rename to assemblies/developer-lightspeed-guide/assembly_run-dev-lightspeed-analysis.adoc index ebae276c..42d23420 100644 --- a/docs/topics/developer-lightspeed/assembly_run-dev-lightspeed-analysis.adoc +++ b/assemblies/developer-lightspeed-guide/assembly_run-dev-lightspeed-analysis.adoc @@ -16,20 +16,18 @@ endif::[] :context: run-dev-lightspeed-analysis [role="_abstract"] -After you complete the configurations, the next step is running an analysis to identify the issues in the code and generate suggestions to resolve the issues. You can get suggestions to fix code by using {mta-dl-full}. - -When you run an analysis, {ProductShortName} displays the issues in the *Analysis Results* view. +After you complete the configurations, the next step is running an analysis to identify the issues in the code and generate suggestions to resolve the issues. When you request code fix suggestions, {mta-dl-plugin} performs the following tasks: -* Streams LLM messages that describe the issue description, resolution, and the file in which the updates are applied. +* Streams LLM messages that describe the issue description, resolution, and the file in which {mta-dl-plugin} applies the updates. * Generates new files in the *Resolutions* pane. These files have the updates to the code to resolve the issues detected in the current analysis. You can review the changes, apply, or revert the updates. If you apply all the resolutions, {mta-dl-plugin} applies the changes and triggers another analysis to check if there are more issues. Subsequent analysis reports fewer issues and incidents. -include::proc_apply-rag-resolution.adoc[leveloffset=+1] +include::topics/developer-lightspeed/proc_apply-rag-resolution.adoc[leveloffset=+1] -include::proc_running-agent-analysis.adoc[leveloffset=+1] +include::topics/developer-lightspeed/proc_running-agent-analysis.adoc[leveloffset=+1] ifdef::parent-context-of-run-dev-lightspeed-analysis[:context: {parent-context-of-run-dev-lightspeed-analysis}] ifndef::parent-context-of-run-dev-lightspeed-analysis[:!context:] diff --git a/docs/topics/developer-lightspeed/assembly_understanding_dl.adoc b/assemblies/developer-lightspeed-guide/assembly_understanding_dl.adoc similarity index 66% rename from docs/topics/developer-lightspeed/assembly_understanding_dl.adoc rename to assemblies/developer-lightspeed-guide/assembly_understanding_dl.adoc index 00ff5a0b..c6ac4486 100644 --- a/docs/topics/developer-lightspeed/assembly_understanding_dl.adoc +++ b/assemblies/developer-lightspeed-guide/assembly_understanding_dl.adoc @@ -18,15 +18,15 @@ endif::[] [role="_abstract"] Understand the {mta-dl-full} extension features, use cases, configurations, and the benefits of using the extension with a large language model (LLM) to generate AI-assisted code resolutions when you want to refactor large codebases. -include::con_intro-to-developer-lightspeed.adoc[leveloffset=+1] +include::topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc[leveloffset=+1] -include::con_dl-context.adoc[leveloffset=+1] +include::topics/developer-lightspeed/con_dl-context.adoc[leveloffset=+1] -include::con_solution_server.adoc[leveloffset=+1] +include::topics/developer-lightspeed/con_solution_server.adoc[leveloffset=+1] -include::con_agent-ai.adoc[leveloffset=+1] +include::topics/developer-lightspeed/con_agent-ai.adoc[leveloffset=+1] -include::ref_dl-benefits.adoc[leveloffset=+1] +include::topics/developer-lightspeed/ref_dl-benefits.adoc[leveloffset=+1] ifdef::parent-context-of-understanding-dl[:context: {parent-context-of-understanding-dl}] diff --git a/assemblies/release-notes/assembly_mta-8-1-0.adoc b/assemblies/release-notes/assembly_mta-8-1-0.adoc index 40f7462b..8db87a12 100644 --- a/assemblies/release-notes/assembly_mta-8-1-0.adoc +++ b/assemblies/release-notes/assembly_mta-8-1-0.adoc @@ -1,5 +1,5 @@ -:_newdoc-version: 2.18.5 -:_template-generated: 2026-02-04 +:_newdoc-version: 2.18.7 +:_template-generated: 2026-04-08 :_mod-docs-content-type: ASSEMBLY ifdef::context[:parent-context-of-mta-8-1-0: {context}] @@ -10,13 +10,13 @@ endif::[] ifdef::context[] [id="mta-8-1-0_{context}"] endif::[] -= {ProductFirstRef} 8.1 += {ProductShortName} 8.1.0 :context: mta-8-1-0 [role="_abstract"] -This Release Notes section provides high-level coverage of the improvements and additions that have been implemented in {ProductFullName} 8.1. - +The {ProductShortName} 8.1.0 section lists the new features and enhancements, Technology Preview features, removed features, fixed issues, and known issues. + include::topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc[leveloffset=+1] include::topics/release-notes-topics/ref_dev-preview-8-1-0.adoc[leveloffset=+1] @@ -26,7 +26,6 @@ include::topics/release-notes-topics/ref_known-issues-8-1-0.adoc[leveloffset=+1] include::topics/release-notes-topics/ref_fixed-issues-8-1-0.adoc[leveloffset=+1] - ifdef::parent-context-of-mta-8-1-0[:context: {parent-context-of-mta-8-1-0}] ifndef::parent-context-of-mta-8-1-0[:!context:] diff --git a/assemblies/release-notes/assembly_mta-8-1-1.adoc b/assemblies/release-notes/assembly_mta-8-1-1.adoc new file mode 100644 index 00000000..a8f06cba --- /dev/null +++ b/assemblies/release-notes/assembly_mta-8-1-1.adoc @@ -0,0 +1,24 @@ +:_newdoc-version: 2.18.7 +:_template-generated: 2026-04-08 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mta-8-1-1: {context}] + +ifndef::context[] +[id="mta-8-1-1"] +endif::[] +ifdef::context[] +[id="mta-8-1-1_{context}"] +endif::[] += {ProductShortName} 8.1.1 + +:context: mta-8-1-1 + +[role="_abstract"] +The {ProductShortName} 8.1.1 section lists the issues fixed in this release. + +include::topics/release-notes-topics/ref_fixed-issues-8-1-1.adoc[leveloffset=+1] + +ifdef::parent-context-of-mta-8-1-1[:context: {parent-context-of-mta-8-1-1}] +ifndef::parent-context-of-mta-8-1-1[:!context:] + diff --git a/assemblies/release-notes/assembly_mta-8-1-2.adoc b/assemblies/release-notes/assembly_mta-8-1-2.adoc new file mode 100644 index 00000000..8854192c --- /dev/null +++ b/assemblies/release-notes/assembly_mta-8-1-2.adoc @@ -0,0 +1,24 @@ +:_newdoc-version: 2.18.7 +:_template-generated: 2026-05-06 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mta-8-1-2: {context}] + +ifndef::context[] +[id="mta-8-1-2"] +endif::[] +ifdef::context[] +[id="mta-8-1-2_{context}"] +endif::[] += {ProductShortName} 8.1.2 + +:context: mta-8-1-2 + +[role="_abstract"] +The {ProductShortName} 8.1.2 section lists the issues fixed in this release. + +include::topics/release-notes-topics/ref_fixed-issues-8-1-2.adoc[leveloffset=+1] + +ifdef::parent-context-of-mta-8-1-2[:context: {parent-context-of-mta-8-1-2}] +ifndef::parent-context-of-mta-8-1-2[:!context:] + diff --git a/assemblies/release-notes/assembly_mta-8-1.adoc b/assemblies/release-notes/assembly_mta-8-1.adoc new file mode 100644 index 00000000..e521f114 --- /dev/null +++ b/assemblies/release-notes/assembly_mta-8-1.adoc @@ -0,0 +1,27 @@ +:_newdoc-version: 2.18.5 +:_template-generated: 2026-02-04 +:_mod-docs-content-type: ASSEMBLY + +ifdef::context[:parent-context-of-mta-8-1-0: {context}] + +ifndef::context[] +[id="mta-8-1-0"] +endif::[] +ifdef::context[] +[id="mta-8-1-0_{context}"] +endif::[] += {ProductFirstRef} 8.1 + +:context: mta-8-1 + +[role="_abstract"] +This Release Notes section provides high-level coverage of the improvements and additions that have been implemented in {ProductFullName} 8.1. + +include::assembly_mta-8-1-2.adoc[leveloffset=+1] + +include::assembly_mta-8-1-1.adoc[leveloffset=+1] + +include::assembly_mta-8-1-0.adoc[leveloffset=+1] + +ifdef::parent-context-of-mta-8-1-0[:context: {parent-context-of-mta-8-1-0}] +ifndef::parent-context-of-mta-8-1-0[:!context:] \ No newline at end of file diff --git a/assemblies/ui-guide/assembly_asset-generation-ui.adoc b/assemblies/ui-guide/assembly_asset-generation-ui.adoc index f521d37a..4b814a35 100644 --- a/assemblies/ui-guide/assembly_asset-generation-ui.adoc +++ b/assemblies/ui-guide/assembly_asset-generation-ui.adoc @@ -20,26 +20,30 @@ To create different assets (manifests) required to deploy applications from Clou To generate assets, familiarize yourself with the following entities: -* Archetypes - Archetypes contain one or more criteria tags to identify technologies such as EAP 6. An archetype helps you to classify applications based on technologies common to them. For asset generation, you can plan your migration paths by archetypes because you configure the other asset generation entities in the archetype (for example, target profiles that contain the generators). +Archetypes:: +An archetype contains criteria tags that identify technologies, such as JBoss EAP 6. ++ +You can use archetypes to classify applications by their common technologies. For asset generation, you plan migration paths by archetype because you configure the other asset generation entities, such as target profiles that contain the generators, directly within the archetype. -* Generators - A generator takes a templating engine, such as Helm, along with a set of templates as input configuration. Generators use the templates that are defined for a target platform and a migration path to generate deployment assets. When you run an asset generation process, the generator parses the application discovery manifest to create deployment assets. +Generators:: +A generator uses a templating engine, such as Helm, and a set of templates as its input configuration. + -For example, the migration path for an EAP 6 application is EAP 8 and the target platform is Kubernetes. A generator can generate the required assets to migrate the EAP 6 application to EAP 8 that is to be deployed on Kubernetes. The assets are generated by parsing the discovery manifest of the EAP 6 application. +When you run an asset generation process, the generator parses the application discovery manifest and uses templates defined for your target platform and migration path to create deployment assets. For example, if you migrate a JBoss EAP 6 application to JBoss EAP 8 on Kubernetes, the generator parses the application's discovery manifest to create the required deployment assets. -* Target profiles - A target profile represents the target platform to which you want to migrate. It contains a sequence of generators. Through target profiles, you can run more than one generator, with each generator creating assets for a specific migration path. Thus, a target profile enables you to generate assets for multiple migration path-target platform combinations at the same time for a given archetype. +Target profiles:: +A target profile represents your target migration platform and contains a sequence of generators. + -For example, if you want to create assets to migrate an EAP 6 application as an OpenJDK 21 application _and_ as an EAP 8 application in {ocp-short} (target platform), you can achieve this through a target profile that has two generators, one for each migration path. +You can use the target profile to run multiple generators simultaneously, where each generator creates assets for a specific migration path. For example, to migrate a JBoss EAP 6 application to both OpenJDK 21 and JBoss EAP 8 on {ocp-short}, you can use a target profile with two generators, one for each migration path. -* Application - The application includes the discovery manifest, tags, and the asset repository. +Applications:: +An application includes tags, the asset repository, and, optionally, the discovery manifest. If the discovery manifest is unavailable, the generator uses implicit data from the application profile. + //provide the retrieve configuration link after publishing the doc -The configuration retrieval process generates a discovery manifest that contains the platform and runtime configurations of an application deployed in the source platform (CF) instances. During asset generation, the discovery manifest is parsed by generator templates that produce the final assets for deployment. +If you want to use the discovery manifest, the configuration retrieval process generates this manifest. The manifest contains the platform and runtime configurations of an application deployed in the source platform (CF) instances. During asset generation, generator templates parse the discovery manifest to create the final deployment assets. + -The application also contains tags that you must configure as criteria tags in an Archetype. +The application also contains tags that you must configure as criteria tags in an archetype. + -The asset repository is where you find the generated assets for deployment in the target platform. - -You can reuse generators in different archetypes. +You can find the assets generated for deployment in the target platform in the asset repository. include::topics/mta-ui/proc_configuring-generators.adoc[leveloffset=+1] diff --git a/assemblies/ui-guide/assembly_configuring-credentials.adoc b/assemblies/ui-guide/assembly_configuring-credentials.adoc index 3a202481..e7a476a5 100644 --- a/assemblies/ui-guide/assembly_configuring-credentials.adoc +++ b/assemblies/ui-guide/assembly_configuring-credentials.adoc @@ -19,11 +19,11 @@ To provide the {ProductFullName} instance environment with secure access to your You can set up the following credential types to configure the {ProductShortName} instance environment: -* Source control -* Maven settings file -* Proxy -* Basic auth (Jira) -* Bearer token (Jira) +* *Source Control* +* *Maven Settings File* +* *Proxy* +* *Basic Auth (Jira)* +* *Bearer Token (Jira)* include::topics/mta-ui/proc_configuring-source-control-credentials.adoc[leveloffset=+1] diff --git a/assemblies/ui-guide/assembly_configuring-mta-instance.adoc b/assemblies/ui-guide/assembly_configuring-mta-instance.adoc index 073e7db9..083796ad 100644 --- a/assemblies/ui-guide/assembly_configuring-mta-instance.adoc +++ b/assemblies/ui-guide/assembly_configuring-mta-instance.adoc @@ -18,13 +18,13 @@ endif::[] [role="_abstract"] To use the {ProductFullName} for migration assessment and analysis, configure an {ProductShortName} instance. By configuring the instance, you ensure that {ProductShortName} considers key parameters during the migration process and generates comprehensive modernization reports. -If you are a project architect, you can configure the instance’s key parameters before migration. The following parameters define applications, individuals, teams, verticals, or areas within an organization affected or participating in the migration: +If you are a project architect, you can configure the instance's key parameters before migration. The following parameters define applications, individuals, teams, verticals, or areas within an organization affected or participating in the migration: -* Stakeholders -* Stakeholder groups -* Job functions -* Business services -* Tag categories +* Stakeholders +* Stakeholder groups +* Job functions +* Business services +* Tag categories * Tags include::topics/mta-ui/proc_creating-a-stakeholder.adoc[leveloffset=+1] diff --git a/assemblies/ui-guide/assembly_configuring-repositories.adoc b/assemblies/ui-guide/assembly_configuring-repositories.adoc index 2cb67030..f886c708 100644 --- a/assemblies/ui-guide/assembly_configuring-repositories.adoc +++ b/assemblies/ui-guide/assembly_configuring-repositories.adoc @@ -17,11 +17,11 @@ endif::[] [role="_abstract"] To allow the {ProductFullName} access to the data required for the migration tasks, configure source and binary repositories in the user interface (UI). -You can configure the following repository types for the {ProductFullName} instance environment: +You can configure the following repository types for the {ProductFullName} instance environment: -* Git -* Subversion -* Maven +* *Git* +* *Subversion* +* *Maven* include::topics/mta-ui/proc_configuring-git-repos.adoc[leveloffset=+1] diff --git a/assemblies/ui-guide/assembly_managing-applications.adoc b/assemblies/ui-guide/assembly_managing-applications.adoc index 6e26e663..ca9f4af2 100644 --- a/assemblies/ui-guide/assembly_managing-applications.adoc +++ b/assemblies/ui-guide/assembly_managing-applications.adoc @@ -22,7 +22,7 @@ You can use the {ProductShortName} UI to perform the following tasks: * Add applications * Assign application credentials * Import a list of applications -* Download a CSV template for importing application lists +* Download a comma-separated values (CSV) file template for importing application lists * Create application migration waves * Create Jira issues for migration waves diff --git a/assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc b/assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc index ec7637ac..d7402391 100644 --- a/assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc +++ b/assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc @@ -45,7 +45,7 @@ The YAML syntax supports including or excluding questions based on tags existing questions: - order: 4 text: Are you currently using any form of container orchestration? - explanation: Determine if the application utilizes container orchestration tools like Kubernetes, Docker Swarm, etc. + explanation: Determine if the application utilizes container orchestration tools such as Kubernetes or Docker Swarm. excludeFor: - category: Deployment tag: Serverless @@ -55,7 +55,7 @@ The YAML syntax supports including or excluding questions based on tags existing ---- Automated answers based on tags present on the assessed application or archetype:: -Automated answers are selected based on the tags existing on the application or archetype. For example, if an application or archetype has the `Runtime/Quarkus` tag, the `Quarkus` answer is automatically selected, and if an application or archetype has the `Runtime/Spring Boot` tag, the `Spring Boot` answer is automatically selected: +The {ProductShortName} selects automated answers based on the tags that exist on the application or archetype. For example, if an application or archetype has the `Runtime/Quarkus` tag, the {ProductShortName} automatically selects the `Quarkus` answer. Similarly, if an application or archetype has the `Runtime/Spring Boot` tag, the {ProductShortName} automatically selects the `Spring Boot` answer: + [source,yaml] ---- @@ -80,14 +80,14 @@ Automated answers are selected based on the tags existing on the application or Automatic tagging of applications based on answers:: -During the assessment, tags are automatically applied to the application or archetype based on the answer if this answer is selected. Note that the tags are transitive. Therefore, the tags are removed if the assessment is discarded. Each tag is defined by the following elements: +During the assessment, the {ProductShortName} automatically applies tags to the application or archetype based on the answer if this answer is selected. Because these tags are transitive, the {ProductShortName} removes them if you discard the assessment. The following elements define each tag: + -- * *category*: Category of the target tag (`String`). * *tag*: Definition for the target tag as (`String`). -- + -For example, if the selected answer is `Quarkus`, the `Runtime/Quarkus` tag is applied to the assessed application or archetype. If the selected answer is `Spring Boot`, the `Runtime/Spring Boot` tag is applied to the assessed application or archetype: +For example, if the selected answer is `Quarkus`, the {ProductShortName} applies the `Runtime/Quarkus` tag to the assessed application or archetype. If the selected answer is `Spring Boot`, the {ProductShortName} applies the `Runtime/Spring Boot` tag to the assessed application or archetype: + [source,yaml] ---- diff --git a/assemblies/ui-guide/assembly_working-with-archetypes.adoc b/assemblies/ui-guide/assembly_working-with-archetypes.adoc index 6663ce53..4ee64603 100644 --- a/assemblies/ui-guide/assembly_working-with-archetypes.adoc +++ b/assemblies/ui-guide/assembly_working-with-archetypes.adoc @@ -17,17 +17,17 @@ endif::[] [role="_abstract"] To assess multiple applications at once in the {ProductFullName} user interface (UI), use archetypes. -An *archetype* is a group of applications with common characteristics. Application archetypes are defined by criteria tags and the application taxonomy. Each archetype defines how the _assessment module_ assesses the application according to the characteristics defined in that archetype. If the tags of an application match the criteria tags of an archetype, the application is associated with the archetype. +An archetype is a group of applications with common characteristics. Tags and the application taxonomy define application archetypes. Each archetype defines how the assessment module assesses the application based on the archetype's characteristics. If an application's tags match an archetype's criteria tags, the system associates the application with that archetype. -Creation of an archetype is defined by a series of *tags*, *stakeholders*, and *stakeholder groups*. The tags include the following types: +The tags include the following types: -* *Criteria tags* are tags that the archetype requires to include an application as a member. +* Criteria tags: Tags that the archetype requires to include an application as a member. + -NOTE: An application must have all of the archetype's criteria tags to be a member. For example, if the application _a_ only has tag _a_, but the archetype _a_ criteria tags include tags _a_ AND _b_, the application _a_ will not be a member of the archetype _a_. +NOTE: An application must have all of the archetype's criteria tags to be a member. For example, if the application _a_ only has tag _a_, but the archetype _a_ criteria tags include tags _a_ and _b_, the application _a_ will not be a member of the archetype _a_. -* *Archetype tags* are tags that are applied to the archetype entity. +* Archetype tags: Tags applied to the archetype entity. -NOTE: All applications associated with the archetype inherit the _assessment_ and _review_ from the archetype groups to which these applications belong. This is the default setting. You can override inheritance for the application by completing an individual assessment and review. +NOTE: All applications associated with the archetype inherit the assessment and review from the archetype groups to which these applications belong. This is the default setting. You can override inheritance for the application by completing an individual assessment and review. include::topics/mta-ui/proc_defining-an-archetype.adoc[leveloffset=+1] diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 48bc0fca..1cd00499 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -1,19 +1,10 @@ :mta: -include::topics/templates/document-attributes.adoc[] -:_mod-docs-content-type: ASSEMBLY -[id="cli-guide"] -= Using the {ProductName} command-line interface - -:toc: -:toclevels: 4 -:numbered: -:imagesdir: topics/images :context: cli-guide :cli-guide: +include::topics/templates/document-attributes.adoc[] -//Inclusive language statement -include::topics/making-open-source-more-inclusive.adoc[] - +[id="cli-guide"] += Using the {ProductName} command-line interface include::topics/mta-cli/con_intro-to-the-cli.adoc[leveloffset=+1] diff --git a/docs/developer-lightspeed-guide/master.adoc b/docs/developer-lightspeed-guide/master.adoc index 042d59c5..e03986b2 100644 --- a/docs/developer-lightspeed-guide/master.adoc +++ b/docs/developer-lightspeed-guide/master.adoc @@ -2,7 +2,7 @@ include::topics/templates/document-attributes.adoc[] :_mod-docs-content-type: ASSEMBLY [id="mta-developer-lightspeed"] -= Configuring and Using Red Hat Developer Lightspeed for MTA += Configuring and using Red Hat Developer Lightspeed for MTA :toc: :toclevels: 4 @@ -11,16 +11,16 @@ include::topics/templates/document-attributes.adoc[] :context: mta-developer-lightspeed :mta-developer-lightspeed: -include::topics/developer-lightspeed/assembly_understanding_dl.adoc[leveloffset=+1] +include::assemblies/developer-lightspeed-guide/assembly_understanding_dl.adoc[leveloffset=+1] -include::topics/developer-lightspeed/assembly_getting-started.adoc[leveloffset=+1] +include::assemblies/developer-lightspeed-guide/assembly_getting-started.adoc[leveloffset=+1] -include::topics/developer-lightspeed/assembly_configuring_llm.adoc[leveloffset=+1] +include::assemblies/developer-lightspeed-guide/assembly_configuring_llm.adoc[leveloffset=+1] -include::topics/developer-lightspeed/assembly_configuring-dev-lightspeed-ide.adoc[leveloffset=+1] +include::assemblies/developer-lightspeed-guide/assembly_configuring-dev-lightspeed-ide.adoc[leveloffset=+1] -include::topics/developer-lightspeed/assembly_run-dev-lightspeed-analysis.adoc[leveloffset=+1] +include::assemblies/developer-lightspeed-guide/assembly_run-dev-lightspeed-analysis.adoc[leveloffset=+1] include::topics/developer-lightspeed/con_developer-lightspeed-logs.adoc[leveloffset=+1] -:!mta-developer-lightspeed: +:mta-developer-lightspeed!: diff --git a/docs/release-notes/master.adoc b/docs/release-notes/master.adoc index 636286db..3b2edda5 100644 --- a/docs/release-notes/master.adoc +++ b/docs/release-notes/master.adoc @@ -11,7 +11,7 @@ include::topics/templates/document-attributes.adoc[] = Release Notes -include::assemblies/release-notes/assembly_mta-8-1-0.adoc[leveloffset=+1] +include::assemblies/release-notes/assembly_mta-8-1.adoc[leveloffset=+1] include::assemblies/release-notes/assembly_mta-8-0.adoc[leveloffset=+1] diff --git a/docs/topics/about-ide-addons.adoc b/docs/topics/about-ide-addons.adoc index 5dc2b512..48a37662 100644 --- a/docs/topics/about-ide-addons.adoc +++ b/docs/topics/about-ide-addons.adoc @@ -4,7 +4,7 @@ // * docs/intellij-idea-plugin-guide/master.adoc // * docs/eclipse-code-ready-guide/master.adoc -:_content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="about-ide-addons_{context}"] = About the {ProductShortName} {AddonType} for {IDEName} diff --git a/docs/topics/developer-lightspeed/assembly_getting-started.adoc b/docs/topics/developer-lightspeed/assembly_getting-started.adoc deleted file mode 100644 index e4a8555b..00000000 --- a/docs/topics/developer-lightspeed/assembly_getting-started.adoc +++ /dev/null @@ -1,44 +0,0 @@ -:_newdoc-version: 2.18.3 -:_template-generated: 2025-05-28 - -ifdef::context[:parent-context-of-getting-started: {context}] - -:_mod-docs-content-type: ASSEMBLY - -ifndef::context[] -[id="getting-started"] -endif::[] -ifdef::context[] -[id="getting-started_{context}"] -endif::[] -= Getting started with {mta-dl-plugin} - -:context: getting-started - -[role="_abstract"] -The Getting started section contains information to walk you through the prerequisites, persistent volume requirements, installation, and workflows that help you to decide how you want to use the {mta-dl-full}. - -[NOTE] -==== -To get support for features in {mta-dl-plugin}, you require a Red Hat Advanced Developer Suite (RHADS) subscription. -==== - -include::con_prerequisites.adoc[leveloffset=+1] - -include::con_persistent-volumes.adoc[leveloffset=+1] - -include::con_installation.adoc[leveloffset=+1] - -include::con_developer-lightspeed-pathways.adoc[leveloffset=+1] - -include::proc_tackle-llm-secret.adoc[leveloffset=+1] - -include::proc_tackle-enable-llm-proxy.adoc[leveloffset=+1] - -include::ref_example-code-suggestion.adoc[leveloffset=+1] - - -ifdef::parent-context-of-getting-started[:context: {parent-context-of-getting-started}] -ifndef::parent-context-of-getting-started[:!context:] - -:!getting-started: \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_agent-ai.adoc b/docs/topics/developer-lightspeed/con_agent-ai.adoc index 51182c49..1ec172a1 100644 --- a/docs/topics/developer-lightspeed/con_agent-ai.adoc +++ b/docs/topics/developer-lightspeed/con_agent-ai.adoc @@ -2,7 +2,7 @@ // // * docs/cli-guide/master.adoc -:_content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="agent-ai_{context}"] = About the Agent AI @@ -12,13 +12,13 @@ You can enable the Agent AI or the Solution Server mode to request AI-assisted code resolutions. In the agentic AI mode, {mta-dl-plugin} streams an automated analysis of the code in a loop and makes changes in the code. In the initial run, the AI agent: * Plans the context to define the issues. -* Chooses a suitable sub agent for the analysis task. {mta-dl-plugin} works with the LLM to generate fix suggestions. The LLM displays the reasoning transcript and files to be changed. +* Chooses a suitable sub agent for the analysis task. {mta-dl-plugin} works with the LLM to generate fix suggestions. The LLM displays the reasoning transcript and files to change. * Applies the changes to the code once you approve the updates. -If you accept that the agentic AI must continue to make changes, it compiles the code and runs a partial analysis. In this iteration, the agentic AI attempts to fix diagnostic issues (if any) generated by tools that you installed in the Visual Studio Code IDE. You can review the changes and accept the agentic AI's suggestion to address these diagnostic issues. +If you accept that the agentic AI must continue to make changes, it compiles the code and runs a partial analysis. In this iteration, the agentic AI attempts to fix diagnostic issues (if any) generated by tools that you installed in the Visual Studio Code Integrated Development Environment (IDE). You can review the changes and accept the agentic AI's suggestion to address these diagnostic issues. After each iteration of applying changes to the code, the agentic AI asks if you want the agent to continue fixing more issues. When you accept, it runs another iteration of automated analysis until it has resolved all issues or it has made a maximum of two attempts to fix an issue. -Agentic AI generates a new preview in each iteration when it updates the code with the suggested resolutions. The time taken by the agentic AI to complete all iterations depends on the number of new diagnostic issues that are detected in the code. +Agentic AI generates a new preview in each iteration when it updates the code with the suggested resolutions. The time that the agentic AI takes to complete all iterations depends on the number of new diagnostic issues that it detects in the code. -:!agent-ai: \ No newline at end of file +:!agent-ai: diff --git a/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc b/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc index 197dd5a1..c8381da8 100644 --- a/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc +++ b/docs/topics/developer-lightspeed/con_developer-lightspeed-logs.adoc @@ -7,21 +7,21 @@ = Debugging {mta-dl-plugin} [role="_abstract"] -{mta-dl-full} generates logs to debug issues specific to the extension host and the {ProductShortName} analysis and RPC server. You can also configure the log level for the {mta-dl-plugin} in the extension settings. The default log level is *debug*. +{mta-dl-full} generates logs to debug issues specific to the extension host and the {ProductShortName} analysis and Remote Procedure Call (RPC) server. You can also configure the log level for the {mta-dl-plugin} in the extension settings. The default log level is *debug*. -Extension logs are stored as `extension.log` with automatic rotation. The maximum size of the log file is 10 MB and three files are retained. Analyzer RPC logs are stored as `analyzer.log` without rotation. +{mta-dl-plugin} stores extension logs as `extension.log` with automatic rotation. The maximum size of the log file is 10 MB and {mta-dl-plugin} retains three files. {mta-dl-plugin} stores analyzer RPC logs as `analyzer.log` without rotation. [id="dev-lightspeed-archive-logs_{context}"] == Archiving the logs -To archive the logs as a zip file, type `{ProductShortName}: Generate Debug Archive` in the Visual Studio Code Command Palette and select the information type that must be archived as a log file. +To archive the logs as a zip file, type `{ProductShortName}: Generate Debug Archive` in the Visual Studio Code Command Palette and select the information type to archive as a log file. The archive command allows capturing all relevant log files in a zip archive at the specified location in your project. By default, you can access the archived logs in the .vscode directory of your project. The archival feature helps you to save the following information: -* Large language model (LLM) provider configuration: Fields from the provider settings that can be included in the archive. All fields are redacted for security reasons by default. Ensure that you do not expose any secrets. +* Large language model (LLM) provider configuration: Fields from the provider settings that you can include in the archive. {mta-dl-plugin} redacts all fields for security reasons by default. Ensure that you do not expose any secrets. * LLM model arguments * LLM traces: If you enabled tracing LLM interactions, you can choose to include LLM traces in the logs. @@ -31,7 +31,7 @@ The archival feature helps you to save the following information: You can access the logs in the following ways: -* *Log file*: Type `Developer: Open Extension Logs Folder` and open the `redhat.mta-vscode-extension` directory that contains the extension log and the analyzer log. +* *Log file*: Type `Developer: Open Extension Logs Folder` and open the `redhat.mta-vscode-extension` directory that has the extension log and the analyzer log. * *Output panel*: Select `{mta-dl-plugin}` from the drop-down menu. diff --git a/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc b/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc index 526ce7ae..df043037 100644 --- a/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc +++ b/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc @@ -7,7 +7,8 @@ = {mta-dl-plugin} workflows [role="_abstract"] -You can opt to use {mta-dl-full} features to request a code fix suggestion after running a static code analysis of an application. +You can configure the {mta-dl-plugin} extension to use centralized configuration and the large language model (LLM) through an LLM proxy. +Alternatively, you can configure the extension to use the LLM provider settings in your Visual Studio Code environment for code resolution suggestions. [NOTE] ==== @@ -26,41 +27,61 @@ You can complete one of the following workflows: As an Administrator, you must: -* Create a xref:tackle-llm-secret_getting-started[secret] for your LLM key in the Red Hat {ocp-name} cluster. +* Create a tackle secret for your LLM key in the Red Hat {ocp-name} cluster. -* In the xref:tackle-enable-llm-proxy_getting-started[Tackle custom resource (CR)], configure the LLM provider and the LLM model. +* Configure the Tackle custom resource (CR) to enable the LLM provider and the LLM model in the Tackle custom resource (CR). As a Migrator, you can complete the following workflow to use the Agent AI mode for code resolutions: -* Enable the generative AI in the xref:configuring-developer-lightspeed-ide-settings_configuring-dev-lightspeed-ide[{ProductShortName} extension settings] +* Enable the generative AI in the {ProductShortName} extension settings. -* Configure a xref:configuring-developer-lightspeed-profile-settings_configuring-dev-lightspeed-ide[profile] for the analysis. +* Configure a profile for the analysis. -* xref:llm-provider-settings_configuring-llm[Activate the LLM provider] in the `provider-settings.yaml` file. +* Activate the LLM provider in the `provider-settings.yaml` file. -* Enable the xref:running-agent-analysis_run-dev-lightspeed-analysis[Agent AI and run an analysis] to request code fix suggestion by using the Agent AI mode. +* Enable the Agent AI and run an analysis to request code fix suggestion by using the Agent AI mode. [id="llm-proxy-workflow_{context}"] == Workflow to use the LLM through the proxy service -You can allow client endpoints, for example, the {ProductShortName} Visual Studio Code extension, to use the proxy service to access the large language models (LLMs). The client uses Keycloak credentials to authenticate to the {ProductShortName} Hub. To authenticate to the LLM, the client sends a JSON Web Token (JWT) issued by Keycloak to the proxy service. The proxy service validates the client's JWT against the Hub's Keycloak instance. +You can allow client endpoints, for example, the {ProductShortName} Visual Studio Code extension, to use the proxy service to access the large language models (LLMs). The client uses Keycloak credentials to authenticate to the {ProductShortName} Hub. To authenticate to the LLM, the client sends a JSON Web Token (JWT) that Keycloak issues to the proxy service. The proxy service validates the client's JWT against the Hub's Keycloak instance. -The proxy service completes a separate authentication process to access the LLM through an Administrator-controlled endpoint. The proxy service authenticates to the LLM by using the cluster secret that contains the LLM API key configured by the Administrator. Thus, the proxy service allows Administrators to create, manage, and rotate LLM API keys without the need to share the LLM key with multiple client endpoints. +The proxy service completes a separate authentication process to access the LLM through an Administrator-controlled endpoint. The proxy service authenticates to the LLM by using the cluster secret that has the LLM API key that the Administrator configured. Thus, the proxy service allows Administrators to create, manage, and rotate LLM API keys without the need to share the LLM key with multiple client endpoints. -After you enable the LLM proxy, you can use either the Solution Server or Agent AI to generate code resolution requests in the IDE extension. To use the Solution Server, the Administrator must deploy it in the {ocp-name} cluster with the proxy service. You cannot use the Solution Server without the proxy service. +After you enable the LLM proxy, you can use either the Solution Server or Agent AI to generate code resolution requests in the Integrated Development Environment (IDE) extension. To use the Solution Server, the Administrator must deploy it in the {ocp-name} cluster with the proxy service. You cannot use the Solution Server without the proxy service. As an Administrator, you must complete the following workflow to enable the LLM proxy in the {ocp-name} cluster: -* Create a xref:tackle-llm-secret_getting-started[secret] for your LLM key in the Red Hat {ocp-name} cluster. +* Create a tackle secret cluster. -* In the xref:tackle-enable-llm-proxy_getting-started[Tackle custom resource (CR)], enable the LLM proxy service, enable the Solution Server if you want Migrators to use the Solution Server mode, and configure the LLM provider and the LLM model. +* Configure the Tackle custom resource (CR) to enable the LLM proxy service, enable the Solution Server if you want Migrators to use the Solution Server mode, and configure the LLM provider and the LLM model. As a Migrator, you can: -* Enable the generative AI in the xref:configuring-developer-lightspeed-ide-settings_configuring-dev-lightspeed-ide[{ProductShortName} extension settings]. +* Enable the generative AI in the {ProductShortName} extension settings. -* If you want to use the Agent AI mode for code resolutions, enable the xref:running-agent-analysis_run-dev-lightspeed-analysis[Agent AI and run an analysis]. +* If you want to use the Agent AI mode for code resolutions, enable the Agent AI and run an analysis. * To use the Solution Server mode: -.. Connect to the {ProductShortName} Hub and run an analysis by using a profile downloaded from the Hub. See link:{mta-URL}/configuring_and_using_the_visual_studio_code_extension_for_mta/index#analyzing-application-profiles_vsc-extension-guide[Running an application analysis by using a profile]. -.. Apply xref:apply-rag-resolution_run-dev-lightspeed-analysis[code resolutions suggested by the Solution Server]. \ No newline at end of file +.. Connect to the {ProductShortName} Hub and run an analysis by using a profile downloaded from the Hub. See Running an application analysis by using a profile. +.. Apply code resolutions that the Solution Server suggests. + +.Additional resources + +* xref:tackle-llm-secret_getting-started[Create a tackle secret in the cluster] + +* xref:tackle-enable-llm-proxy_getting-started[Configure the Tackle custom resource (CR)] + +* xref:configuring-developer-lightspeed-ide-settings_configuring-dev-lightspeed-ide[Enable generative AI in the {ProductShortName} extension settings] + +* xref:configuring-developer-lightspeed-profile-settings_configuring-dev-lightspeed-ide[Configure a profile] + +* xref:llm-provider-settings_configuring-llm[Activate the LLM provider] + +* xref:running-agent-analysis_run-dev-lightspeed-analysis[Enable Agent AI and run an analysis] + +* xref:configuring-developer-lightspeed-ide-settings_configuring-dev-lightspeed-ide[{ProductShortName} extension settings] + +* link:{mta-URL}/configuring_and_using_the_visual_studio_code_extension_for_mta/index#analyzing-application-profiles_vsc-extension-guide[Running an application analysis by using a profile] + +* xref:apply-rag-resolution_run-dev-lightspeed-analysis[code resolutions that the Solution Server suggests] \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_dl-context.adoc b/docs/topics/developer-lightspeed/con_dl-context.adoc index dfb14797..c542aa20 100644 --- a/docs/topics/developer-lightspeed/con_dl-context.adoc +++ b/docs/topics/developer-lightspeed/con_dl-context.adoc @@ -2,7 +2,7 @@ // // * docs/cli-guide/master.adoc -:_content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="dl-context_{context}"] [role=_abstract] @@ -10,20 +10,20 @@ :context: dl-context -The context is a combination of the source code, the issue description, and solved examples: +The context is a combination of the source code, the issue description, and solved examples: -* Description of issues detected by {ProductShortName} when you run a static code analysis for a given set of target technologies. +* Description of issues that {ProductShortName} detects when you run a static code analysis for a given set of target technologies. * (Optional) The default and custom rules may contain additional information that you include which can help {mta-dl-plugin} to define the context. + -* Solved examples constitute code changes from other migrations and a pattern of resolution for an issue that can be used in future. A solved example is created when a Migrator accepts a resolution in a previous analysis that results in updated code or an unfamiliar issue in a legacy application that the Migrator manually fixed. Solved examples are stored in the Solution Server. +* Solved examples constitute code changes from other migrations and a pattern of resolution for an issue to use in future. {mta-dl-plugin} creates a solved example when a Migrator accepts a resolution in an earlier analysis that results in updated code or an unfamiliar issue in a legacy application that the Migrator manually fixed. The Solution Server stores solved examples. + -More instances of solved examples for an issue enhance the context and improve the success metrics of rules that trigger the issue. Higher the success metrics of an issue, greater the confidence level associated with the accepted resolutions for that issue in previous analyses. +More instances of solved examples for an issue enhance the context and improve the success metrics of rules that trigger the issue. Higher the success metrics of an issue, greater the confidence level associated with the accepted resolutions for that issue in earlier analyses. -* (Optional) If you enable the Solution Server, it extracts a pattern of resolution, called the migration hint, that can be used by the LLM to generate a more accurate fix suggestion in a future analysis. +* (Optional) If you enable the Solution Server, it extracts a pattern of resolution, called the migration hint, that the LLM can use to generate a more accurate fix suggestion in a future analysis. + -The improvement in the quality of migration hints results in more accurate code resolutions. Accurate code resolutions from the LLM result in the user accepting an update to the code. The updated code is stored in the Solution Server to generate a better migration hint in future. +The improvement in the quality of migration hints results in more accurate code resolutions. Accurate code resolutions from the LLM result in the user accepting an update to the code. The Solution Server stores the updated code to generate a better migration hint in future. + This cyclical improvement of resolution pattern from the Solution Server and improved migration hints lead to more reliable code changes as you migrate applications in different migration waves. -:!dl-context: \ No newline at end of file +:!dl-context: diff --git a/docs/topics/developer-lightspeed/con_installation.adoc b/docs/topics/developer-lightspeed/con_installation.adoc index 9482ad59..ab28113d 100644 --- a/docs/topics/developer-lightspeed/con_installation.adoc +++ b/docs/topics/developer-lightspeed/con_installation.adoc @@ -7,6 +7,9 @@ = Installation [role="_abstract"] -You can install the {ProductFullName} 8.0.0 Visual Studio Code plug-in from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code marketplace]. +You can install the {ProductFullName} 8.0.0 Visual Studio Code plugin from the Visual Studio Code marketplace. -You can use the {ProductShortName} Visual Studio Code plug-in to perform analysis and optionally enable {mta-dl-full} to use generative AI capabilities. You can fix code issues before migrating the application to target technologies by using the generative AI capabilities. \ No newline at end of file +You can use the {ProductShortName} Visual Studio Code plugin to perform analysis and optionally enable {mta-dl-full} to use generative AI capabilities. You can fix code issues before migrating the application to target technologies by using the generative AI capabilities. + +.Additional resources +* link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code marketplace] \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc index 62ba5d3b..cd091049 100644 --- a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc +++ b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc @@ -2,34 +2,32 @@ // // * docs/cli-guide/master.adoc -:_content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="intro-to-the-developer-lightspeed_{context}"] = Introduction to the {mta-dl-plugin} :context: intro-to-the-developer-lightspeed [role="_abstract"] -Starting from 8.0.0, {ProductFullName} integrates with large language models (LLM) through the {mta-dl-full} component in the Visual Studio Code extension. You can use {mta-dl-plugin} to apply LLM-driven code changes to resolve issues found through static code analysis of Java applications. +Starting from 8.0.0, {ProductFullName} integrates with large language models (LLM) through the {mta-dl-full} plugin in the Visual Studio Code extension. You can use {mta-dl-plugin} to apply LLM-assisted code changes to resolve issues that static code analysis identifies in Java applications. [id="use-case-ai-code-fix_{context}"] == Use case for AI-driven code fixes {ProductFirstRef} performs the static code analysis for a specified target technology to which you want to migrate your applications. Red Hat provides 2400+ analysis rules in {ProductShortName} for various Java technologies and you can extend the ruleset for custom frameworks or new technologies by creating custom rules. -The static code analysis describes the issues in your code that must be resolved. As you perform analysis for a large portfolio of applications, the issue description and the rule definition that may contain additional information form a large corpus of data that contains repetitive patterns of problem definitions and solutions. +The static code analysis describes the issues in your code that you must resolve. As you perform analysis for a large portfolio of applications, the issue description and the rule definition that may contain additional information form a large corpus of data that has repetitive patterns of problem definitions and solutions. -Migrators do duplicate work by resolving issues that are repeated across applications in different migration waves. +Migrators do duplicate work by resolving issues that repeat across applications in different migration waves. [id="how-developerlightspped-works_{context}"] == Red{nbsp}Hat Developer Lightspeed for {ProductShortName} overview -{mta-dl-plugin} works by collecting and storing the changes in the code for a large collection of applications, finding context to generate prompts for the LLM of your choice, and by generating code resolutions produced by the LLM to address specific issues. +{mta-dl-plugin} works by collecting and storing the changes in the code for a large collection of applications, finding context to generate prompts for the LLM of your choice, and by generating code resolutions that the LLM produces to address specific issues. -{mta-dl-plugin} augments the manual changes made to code throughout your organization in different migration waves and creates a context for a large language model (LLM). The LLM suggests code resolutions based on the issue description, context, and previous examples of code changes to resolve issues. +{mta-dl-plugin} augments the manual changes that you make to code throughout your organization in different migration waves and creates a context for a large language model (LLM). The LLM suggests code resolutions based on the issue description, context, and earlier examples of code changes to resolve issues. -{mta-dl-plugin} uses Retrieval Augmented Generation for context-based resolutions of issues in code. By using RAG, {mta-dl-plugin} improves the context shared with the LLM to generate more accurate suggestions to fix the issue in the code. The context allows the LLM to "reason" and generate suggestions for issues detected in the code. This mechanism helps to overcome the limited context size in LLMs that prevents them from analyzing the entire source code of an application. - -//You can consider using the demo mode for running {mta-dl-plugin} when you need to perform analysis but have a limited network connection for {mta-dl-plugin} to sync with the LLM. The demo mode stores the input data as a hash and past LLM calls in a cache. The cache is stored in a chosen location in the your file system for later use. The hash of the inputs is used to determine which LLM call must be used in the demo mode. After you enable the demo mode and configure the path to your cached LLM calls in the {mta-dl-plugin} settings, you can rerun an analysis for the same set of files using the responses to a previous LLM call. +{mta-dl-plugin} uses Retrieval Augmented Generation (RAG) for context-based resolutions of issues in code. By using RAG, {mta-dl-plugin} improves the context that it shares with the LLM to generate more accurate suggestions to fix the issue in the code. The context allows the LLM to "reason" and generate suggestions for issues that it detects in the code. This mechanism helps to overcome the limited context size in LLMs that prevents them from analyzing the entire source code of an application. :FeatureName: Developer Lightspeed for {ProductShortName} @@ -37,9 +35,13 @@ Migrators do duplicate work by resolving issues that are repeated across applica ==== [subs="attributes+"] {FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. - -For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. ==== :!FeatureName: -:!intro-to-the-developer-lightspeed: \ No newline at end of file +<<<<<<< HEAD +.Additional resources +* link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope] +:!intro-to-the-developer-lightspeed: +======= +:!intro-to-the-developer-lightspeed: +>>>>>>> 1a8b1d6 (Updating files using the deprecated :_content-type: attribute, updated to :_mod-docs-content-type: (#368)) diff --git a/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc b/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc index 71b6b939..0238b3e9 100644 --- a/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc +++ b/docs/topics/developer-lightspeed/con_llm-service-openshift-ai.adoc @@ -9,7 +9,7 @@ [role="_abstract"] The code suggestions from {mta-dl-full} differ based on the large language model (LLM) that you use. Therefore, you may want to use an LLM that caters to your specific requirements. -{mta-dl-plugin} integrates with LLMs that are deployed as a scalable service on {ocp-name} AI clusters. These deployments provide you with granular control over resources such as compute, cluster nodes, and auto-scaling Graphical Processing Units (GPUs) while enabling you to leverage LLMs to resolve code issues at a large scale. +{mta-dl-plugin} integrates with LLMs that you deployed as a scalable service on {ocp-name} AI clusters. These deployments give you granular control over resources such as compute, cluster nodes, and auto-scaling Graphical Processing Units (GPUs) while enabling you to use LLMs to resolve code issues at a large scale. An example workflow for configuring an LLM service on {ocp-name} AI broadly requires the following configurations: @@ -30,4 +30,5 @@ An example workflow for configuring an LLM service on {ocp-name} AI broadly requ ** Configure an OpenAI API key ** Update the OpenAI API key and the base URL in `provider-settings.yaml`. -See xref:llm-provider-settings_{context}[Configuring LLM provider settings] to configure the base URL and the LLM API key in the {mta-dl-plugin} Visual Studio Code extension. \ No newline at end of file +.Additional resources +* xref:llm-provider-settings_{context}[Configuring LLM provider settings] \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_persistent-volumes.adoc b/docs/topics/developer-lightspeed/con_persistent-volumes.adoc index b2320018..b7a5126b 100644 --- a/docs/topics/developer-lightspeed/con_persistent-volumes.adoc +++ b/docs/topics/developer-lightspeed/con_persistent-volumes.adoc @@ -7,6 +7,10 @@ = Persistent volume requirements [role="_abstract"] -The Solution Server component requires a backend database to store code changes from previous analyses. +The Solution Server component requires a backend database to store code changes from earlier analyses. -If you plan to enable Solution Server, you must create a `5Gi` `RWO` persistent volume used by the {mta-dl-plugin} database. See link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] for more information. +If you plan to enable Solution Server, you must create a `5Gi` ReadWriteOnce (`RWO`) persistent volume for the {mta-dl-plugin} database. + +[id="_additional-resources"] +.Additional resources +* link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] diff --git a/docs/topics/developer-lightspeed/con_prerequisites.adoc b/docs/topics/developer-lightspeed/con_prerequisites.adoc index 5e3367a8..d70c049d 100644 --- a/docs/topics/developer-lightspeed/con_prerequisites.adoc +++ b/docs/topics/developer-lightspeed/con_prerequisites.adoc @@ -7,7 +7,7 @@ = Prerequisites [role="_abstract"] -This section lists the prerequisites required to successfully use the generative AI features in the {mta-dl-plugin} Visual Studio Code extension. +You can use the prerequisites required to successfully use the generative AI features in the {mta-dl-plugin} Visual Studio Code extension. Before you install {mta-dl-plugin}, you must: @@ -22,7 +22,7 @@ Before you install {mta-dl-plugin}, you must: * Install the {ProductShortName} Operator 8.0.0 + -The {ProductShortName} Operator is mandatory if you plan to enable the Solution Server that works with the large language model (LLM) for generating code changes. It enables you to log in to the `openshift-mta` project where you must enable the Solution Server in the Tackle custom resources (CR). +The {ProductShortName} Operator is mandatory if you plan to enable the Solution Server that works with the large language model (LLM) for generating code changes. Use the Operator to log in to the `openshift-mta` project where you must enable the Solution Server in the Tackle custom resources (CR). * Create an API key for an LLM. + @@ -33,7 +33,7 @@ You must enter the provider value and model name in Tackle CR to enable generati |=== | LLM Provider (Tackle CR value) | Large language model examples for Tackle CR configuration -| {ocp-name} AI platform| Models deployed in an {ocp-name} AI cluster that can be accessed by using Open AI-compatible API. +| {ocp-name} AI platform| Models that you deploy in an {ocp-name} AI cluster and access by using Open AI-compatible API. | Open AI (`openai`) | `gpt-4`, `gpt-4o`, `gpt-4o-mini`, `gpt-3.5-turbo` | Azure OpenAI (`azure_openai`) | `gpt-4`, `gpt-35-turbo` | Amazon Bedrock (`bedrock`) | `anthropic.claude-3-5-sonnet-20241022-v2:0`, `meta.llama3-1-70b-instruct-v1:0` @@ -44,5 +44,5 @@ You must enter the provider value and model name in Tackle CR to enable generati [NOTE] ==== -The availability of public LLM models is maintained by the respective LLM provider. +The LLM provider maintains the availability of public LLM models. ==== \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_solution_server.adoc b/docs/topics/developer-lightspeed/con_solution_server.adoc index 56422041..f2a9c1c7 100644 --- a/docs/topics/developer-lightspeed/con_solution_server.adoc +++ b/docs/topics/developer-lightspeed/con_solution_server.adoc @@ -2,31 +2,29 @@ // // * docs/cli-guide/master.adoc -:_content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="solution-server_{context}"] = About the Solution Server :context: solution-server [role=_abstract] -Solution Server is a component that allows {mta-dl-plugin} to build a collective memory of source code changes from all analyses performed in an organization. This helps you to use the recurring patterns of solutions for issues that repeat in many applications. You can opt to use the Solution Server to request AI-assisted code resolutions. +Solution Server is a component that allows {mta-dl-plugin} to build a collective memory of source code changes from all analyses that an organization performs. This helps you to use the recurring patterns of solutions for issues that repeat in many applications. You can opt to use the Solution Server to request AI-assisted code resolutions. -The Solution Server augments previous patterns of how source code changed to resolve issues (also called solved examples) that were similar to those in the current file, and suggests a resolution that has a higher confidence level derived from previous solutions. After you accept a suggested code fix, the Solution Server works with the large language model (LLM) to improve the hints about the issue that becomes part of the context. An improved context enables the LLM to generate more reliable code fix suggestions in future cases. +The Solution Server augments earlier patterns of how source code changed to resolve issues (also called solved examples) that were similar to those in the current file, and suggests a resolution that has a higher confidence level derived from earlier solutions. After you accept a suggested code fix, the Solution Server works with the large language model (LLM) to improve the hints about the issue that becomes part of the context. An improved context enables the LLM to generate more reliable code fix suggestions in future cases. The Solution Server delivers two primary benefits to users: * *Contextual Hints*: It surfaces examples of past migration solutions, including successful user modifications and accepted fixes, offering actionable hints for difficult or previously unsolved migration problems. -* *Migration Success Metrics*: It exposes detailed success metrics for each migration rule, derived from real-world usage data. These metrics can be used by IDEs or automation tools to present users with a “confidence level” or likelihood of {mta-dl-plugin} successfully migrating a given code segment. +* *Migration Success Metrics*: It exposes detailed success metrics for each migration rule, derived from real-world usage data. Integrated Development Environments (IDEs) or automation tools can use these metrics to present users with a “confidence level” or likelihood of {mta-dl-plugin} successfully migrating a given code segment. -When you use the Solution Server, you can view a diff of the updated portions of the code and the original source code to do a manual review. In a manual review of the suggested AI resolutions, you can accept, reject, or edit the suggested code changes. +When you use the Solution Server, you can view a diff of the updated portions of the code and the original source code to do a manual review. In a manual review of the suggested AI resolutions, you can accept, reject, or edit the suggested code changes. :FeatureName: Solution Server [IMPORTANT] ==== [subs="attributes+"] {FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. - -For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. ==== :!FeatureName: @@ -34,7 +32,7 @@ For more information about the support scope of Red Hat Technology Preview featu |=== | LLM Provider (Tackle CR value) | Large language model examples for Tackle CR configuration -|{ocp-name} AI platform| Models deployed in an OpenShift AI cluster that can be accessed by using Open AI-compatible API +|{ocp-name} AI platform| Models that you deploy in an OpenShift AI cluster and access by using Open AI-compatible API | Open AI (`openai`) | `gpt-4`, `gpt-4o`, `gpt-4o-mini`, `gpt-3.5-turbo` | Azure OpenAI (`azure_openai`) | `gpt-4`, `gpt-35-turbo` | Amazon Bedrock (`bedrock`) | `anthropic.claude-3-5-sonnet-20241022-v2:0`, `meta.llama3-1-70b-instruct-v1:0` @@ -43,4 +41,6 @@ For more information about the support scope of Red Hat Technology Preview featu |=== -:!solution-server: \ No newline at end of file +.Additional resources +* link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope] +:!solution-server: diff --git a/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc b/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc index b3a690f0..0565cc52 100644 --- a/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc +++ b/docs/topics/developer-lightspeed/proc_apply-rag-resolution.adoc @@ -6,7 +6,7 @@ = Applying resolutions generated by the solution server [role="_abstract"] -When you request code resolutions by enabling the Solution Server, an issue displays the success metric when the metric becomes available. A success metric indicates the confidence level in applying the fix suggestion from the LLM based on how many times the update was applied in past analysis. +When you request code resolutions by enabling the Solution Server, an issue displays the success metric when the metric becomes available. A success metric indicates the confidence level in applying the fix suggestion from the LLM based on how many times you applied the update in past analyses. You can review the code updates and edit the suggested code resolutions before accepting the suggestions. @@ -20,11 +20,11 @@ You can review the code updates and edit the suggested code resolutions before a . Review the issues from the *Analysis results* space of the *{ProductShortName} view analysis* page by the following tabs: .. *All*: lists all incidents identified in your project. -.. *Files*: lists all the files in your project for which the analysis identified issues that must be resolved. +.. *Files*: lists all the files in your project for which the analysis identified issues that you must resolve. .. *Issues*: lists all issues across different files in your project. . Use the *Category* drop down to filter issues based on how crucial the fix is for the target migration. You can filter mandatory, potential, and optional issues. -. Click *Has Success Rate* to check how many times the same issue resolution was accepted in previous analysis. -. Click the solution tool to trigger automated updates to your code. If you applied any category filter, code updates are made for all incidents, specific files, or specific issues based on the filter. +. Click *Has Success Rate* to check how many times you accepted the same issue resolution in an earlier analysis. +. Click the solution tool to trigger automated updates to your code. If you applied any category filter, {mta-dl-plugin} makes code updates for all incidents, specific files, or specific issues based on the filter. {mta-dl-plugin} generates new files with the updated code. . Review and (optionally) edit the code. . Click *Apply all* in the *Resolutions* pane to permanently apply the changes to your code. \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc b/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc index 90b7bc4a..da054a38 100644 --- a/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc +++ b/docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc @@ -6,9 +6,9 @@ = Configuring the {mta-dl-plugin} IDE settings [role="_abstract"] -After you install the {ProductShortName} extension in Visual Studio Code, you must provide your large language model (LLM) credentials to activate {mta-dl-plugin} settings in Visual Studio Code. +Configure the Visual Studio Code Integrated Development Environment (IDE) settings to perform analyses and AI-assisted code resolutions. You can broadly categorize the extension settings into debugging and logging, {mta-dl-plugin} settings, analysis settings, and Solution Server settings. -{mta-dl-plugin} settings are applied to all AI-assisted analyses that you perform by using the {ProductShortName} extension. The extension settings can be broadly categorized into debugging and logging, {mta-dl-plugin} settings, analysis settings, and Solution Server settings. +After you install the {ProductShortName} extension in Visual Studio Code, you must enter your large language model (LLM) credentials to use {mta-dl-plugin} in the Visual Studio Code IDE. .Prerequisites @@ -20,9 +20,9 @@ In addition to the overall prerequisites, you have configured the following: . Go to the {mta-dl-plugin} settings in one of the following ways: + -.. Click `Extensions > {ProductShortName} Extension for VSCode > Settings` +.. Click `Extensions > {ProductFirstRef} Extension > Settings` + -.. Type `Ctrl + Shift + P` or `Cmd + Shift + P` on the search bar to open the Command Palette and enter `Preferences: Open Settings (UI)`. Go to `Extensions > {ProductShortName}` to open the settings page. +.. Type `Ctrl+Shift+P` or `Cmd+Shift+P` on the search bar to open the Command Palette and enter `Preferences: Open Settings (UI)`. Go to `Extensions > {ProductShortName}` to open the settings page. + . Configure the settings described in the following table: + @@ -32,15 +32,15 @@ In addition to the overall prerequisites, you have configured the following: |==== |Settings |Description |Log level|Set the log level for the {ProductShortName} binary. The default log level is `debug`. The log level increases or decreases the verbosity of logs. -|Analyzer path|Specify an {ProductShortName} custom binary path. If you do not provide a path, {mta-dl-plugin} uses the default path to the binary. -|Auto Accept on Save|This option is enabled by default. When you accept the changes suggested by the LLM, the updated code is saved automatically in a new file. Disable this option if you want to manually save the new file after accepting the suggested code changes. -|Gen AI:Enabled|This option is enabled by default. It enables you to get code fixes by using {mta-dl-plugin} with a large language model. +|Analyzer path|Specify an {ProductShortName} custom binary path. If you do not give a path, {mta-dl-plugin} uses the default path to the binary. +|Auto Accept on Save|{mta-dl-plugin} enables this option by default. When you accept the changes that the LLM suggests, {mta-dl-plugin} automatically saves the updated code in a new file. Disable this option if you want to manually save the new file after accepting the code changes. +|Gen AI:Enabled|{mta-dl-plugin} enables this option by default. You can get code fixes by using {mta-dl-plugin} with a large language model. |Gen AI: Agent mode|Enable the experimental Agentic AI flow for analysis. {mta-dl-plugin} runs an automated analysis of a file to identify issues and suggest resolutions. After you accept the solutions, {mta-dl-plugin} makes the changes in the code and re-analyzes the file. -|Gen AI: Excluded diagnostic sources|Add diagnostic sources in the `settings.json` file. The issues generated by such diagnostic sources are excluded from the automated Agentic AI analysis. +|Gen AI: Excluded diagnostic sources|Add diagnostic sources in the `settings.json` file. {mta-dl-plugin} excludes the issues that such diagnostic sources generate from the automated Agentic AI analysis. |Cache directory|Specify the path to a directory in your filesystem to store cached responses from the LLM. -|Trace directory|Configure the absolute path to the directory that contains the saved LLM interaction. -|Trace enabled|Enable to trace {ProductShortName} communication with the LLM model. Traces are stored in the trace directory that you configured. -|Demo mode|Enable to run {mta-dl-plugin} in demo mode that uses the LLM responses saved in the `cache` directory for analysis. +|Trace directory|Configure the absolute path to the directory that has the saved LLM interaction. +|Trace enabled|Enable to trace {ProductShortName} communication with the LLM model. {mta-dl-plugin} stores traces in the trace directory that you configured. +|Demo mode|Enable to run {mta-dl-plugin} in demo mode that uses the LLM responses from the `cache` directory for analysis. |Debug:Webview|Enable debug level logging for Webview message handling in Visual Studio Code. |==== diff --git a/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc b/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc index 066bc917..0c29ff6a 100644 --- a/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc +++ b/docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc @@ -6,47 +6,47 @@ = Configuring the {mta-dl-plugin} profile settings [role="_abstract"] -You can use the Visual Studio Code plugin to run an analysis to discover issues in the code. You can optionally enable {mta-dl-full} to get AI-assisted code suggestions. - -To generate code changes using {mta-dl-plugin}, you must configure a profile that contains all the necessary configurations, such as source and target technologies and the API key to connect to your chosen large language model (LLM). +To perform repeated analyses, you can create a reusable profile configuration. You can use the profile you configure in your Integrated Development Environment (IDE). .Prerequisites * You completed the Solution Server configurations in Tackle custom resource if you opt to use the Solution Server. -* You opened a Java project in your Visual Studio Code workspace. +* You opened a project in your Visual Studio Code workspace. .Procedure . Open the `{ProductShortName} View Analysis` page in either of the following ways: -+ .. Click the book icon on the `{ProductShortName}: Issues` pane of the {ProductShortName} extension. .. Type `Ctrl + Shift + P` or `Cmd + Shift + P` on the search bar to open the Command Palette and enter `{ProductShortName}:Open Analysis View`. -+ . Click the settings button on the `{ProductShortName} View Analysis` page to configure a profile for your project. -The `Get Ready to Analyze` pane lists the following basic configurations required for an analysis: + - -.Verification - -After you complete the profile configuration, close the `Get Ready to Analyze` pane. You can verify that your configuration works by running an analysis. - +The `Get Ready to Analyze` pane lists the profile configuration options. ++ .{mta-dl-plugin} profile settings [cols="20%,80%a",options="header",] |==== |Profile settings |Description -|Select profile|Create a profile that you can reuse for multiple analyses. The profile name is part of the context provided to the LLM for analysis. +|Select profile|Create a profile. The profile name is part of the context provided to the LLM for analysis. |Configure label selector|A label selector filters rules for analysis based on the source or target technology. -Specify one or more target or source technologies (for example, cloud-readiness). {mta-dl-plugin} uses this configuration to determine the rules that are applied to a project during analysis. +Specify one or more target or source technologies (for example, cloud-readiness). {mta-dl-plugin} uses this configuration to determine the rules to apply to a project during analysis. If you mentioned a new target or a source technology in your custom rule, you can type that name to create and add the new item to the list. [NOTE] ==== -You must configure either target or source technologies before running an analysis. +You must configure either target or source technologies for running an analysis. ==== |Set rules|Enable default rules and select your custom rule that you want {ProductShortName} to use for an analysis. You can use the custom rules in addition to the default rules. -|Configure generative AI|This option opens the `provider-settings.yaml` file that contains API keys and other parameters for all supported LLMs. By default, {mta-dl-plugin} is configured to use OpenAI LLM. To change the model, update the anchor `&active` to the desired block. Modify this file with the required arguments, such as the model and API key, to complete the setup. +|Configure generative AI|This option opens the `provider-settings.yaml` file that has API keys and other parameters for all supported LLMs. By default, {mta-dl-plugin} uses OpenAI LLM. To change the model, update the anchor `&active` to the desired block. Modify this file with the required arguments, such as the model and API key, to complete the setup. |==== -See xref:llm-provider-settings_configuring-llm[Configuring LLM provider settings] to complete the LLM provider configuration. + +.Verification + +After you complete the profile configuration: + +. Open *{ProductShortName} Analysis View*. +. Click *Run Analysis* to verify that your configuration works by running an analysis. + + diff --git a/docs/topics/developer-lightspeed/proc_configuring-llm-podman-desktop.adoc b/docs/topics/developer-lightspeed/proc_configuring-llm-podman-desktop.adoc index 4989e37d..014425cb 100644 --- a/docs/topics/developer-lightspeed/proc_configuring-llm-podman-desktop.adoc +++ b/docs/topics/developer-lightspeed/proc_configuring-llm-podman-desktop.adoc @@ -6,13 +6,13 @@ = Configuring the LLM in Podman Desktop [role="_abstract"] -The Podman AI lab extension enables you to use an open-source model from a curated list of models and use it locally in your system. +Use the Podman AI lab extension to select an open source model from a curated list of models and run it locally in your system. -The code fix suggestions generated by a model depends on the model's capabilities. Models deployed through the Podman AI Lab were found to be insufficient for the complexity of code changes required to fix issues discovered by {ProductShortName}. You must not use such models in a production environment. +The code fix suggestions that a model generates depend on the model's capabilities. Models from the Podman AI Lab are insufficient for the complexity of code changes needed to fix issues that {ProductShortName} discovers. You must not use such models in a production environment. .Prerequisites -* You installed link:https://podman-desktop.io/docs/installation[Podman Desktop] in your system. +* You installed Podman Desktop in your system. * You completed initial configurations in {mta-dl-plugin} required for the analysis. @@ -57,4 +57,8 @@ podman_mistral: &active [NOTE] ==== The Podman Desktop service endpoint does not need a password but the OpenAI library expects the `OPENAI_API_KEY` to be set. In this case, the value of the `OPENAI_API_KEY` variable does not matter. -==== \ No newline at end of file +==== + +.Additional resources + +* link:https://podman-desktop.io/docs/installation[Podman Desktop] \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc b/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc index 93b0d3a4..a3d29319 100644 --- a/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc +++ b/docs/topics/developer-lightspeed/proc_running-agent-analysis.adoc @@ -6,11 +6,9 @@ = Generating code resolutions in the agent mode [role="_abstract"] -In the agent mode, the {mta-dl-plugin} planning agent creates the context for an issue and picks a sub-agent that is most suited to resolve the issue. The sub-agent runs an automated scan to describe how the issue can be resolved and generates files with the updated resolutions in one stream. +As a Migrator, you can use the agent mode to run an automated analysis that streams the code resolutions that the agent can apply to your source code. When using the agent mode, you can reject the changes or stop the stream but you cannot edit the updated files during the stream. -You can review the updated files and approve or reject the changes to the code. The agent runs another automated analysis to detect new issues in the code that may have occurred because of the accepted changes or diagnostic issues that your tool may generate following a previous analysis. If you allow the process to continue, {mta-dl-plugin} runs the stream again and generates a new file with the latest updates. - -When using the agent mode, you can reject the changes or discontinue the stream but you cannot edit the updated files during the stream. +The agent detects new issues in the code that may have occurred because of the earlier accepted changes or diagnostic issues that your tool may generate following an earlier analysis. If you allow the process to continue, {mta-dl-plugin} runs the stream again and generates a new file with the latest updates. .Prerequisites @@ -19,22 +17,21 @@ When using the agent mode, you can reject the changes or discontinue the stream .Procedure -. Verify that agent mode is enabled in one of the following ways: +. Enable the agent mode in one of the following ways: + -.. Type `Ctrl + Shift + P` in Visual Studio Code search (Linux/Windows system) and `Cmd + Shift + P` for Mac to go to the command palette. -.. Enter `Preferences: Open User Settings (JSON)` to open the `settings.json` file. -.. Ensure that `mta-vscode-extension.genai.agentMode` is set to `true`. +.. Open the *MTA Analysis View* page. +.. Enable the *Agent Mode* on. + OR + -.. Go to *Extensions > {mta-dl-plugin} > settings* -.. Click the *Agent Mode* option to enable the server. +.. Go to *Extensions > {ProductShortName}-core > GenAI: Agent Mode* +.. Select the *Agent Mode* checkbox. + . Click the {mta-dl-plugin} extension and click *Open {ProductShortName} Analysis View*. + . Select a profile for the analysis. + -. Click *Start* to start the {ProductShortName} RPC server. +. Click *Start* to start the {ProductShortName} Remote Procedure Call (RPC) server. + . Click *Run Analysis* on the *{ProductShortName} Analysis View* page. The *Resolution Details* tab opens, where you can view the automated analysis that makes changes in applicable files. diff --git a/docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc b/docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc deleted file mode 100644 index 4f92f2a1..00000000 --- a/docs/topics/developer-lightspeed/proc_tackle-enable-dev-lightspeed.adoc +++ /dev/null @@ -1,80 +0,0 @@ -:_newdoc-version: 2.15.0 -:_template-generated: 2024-2-21 -:_mod-docs-content-type: PROCEDURE - -[id="tackle-enable-dev-lightspeed_{context}"] -= Enabling {mta-dl-plugin} in Tackle custom resource - -[role="_abstract"] -Solution Server integrates with the {ProductShortName} Hub backend component to use the database and volumes necessary to store and retrieve the solved examples. - -To enable Solution Server and other AI configurations in the {mta-dl-full} Visual Studio Code extension, you must modify the Tackle custom resource (CR) with additional parameters. - -[NOTE] -==== -To use the Solution Server, the Administrator must deploy it in the {ocp-name} cluster with the proxy service. You cannot use the Solution Server without the proxy service. See xref:tackle-enable-llm-proxy_getting-started[Enabling LLM proxy in the Tackle custom resource] for more information. -==== - -.Prerequisites - -//the hard link must be changed to the same topic in 8.0.0 that has the `{mta-dl-plugin}-database` req. -. You deployed an additional RWO volume for the `{mta-dl-plugin}-database` if you want to use {mta-dl-plugin}. See link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] for more information. - -. You installed the {ProductShortName} operator v8.0.0. - - -.Procedure - -. Log in to the Red Hat {ocp-name} cluster and switch to the `openshift-mta` project. -+ -. Edit the Tackle CR settings in the `tackle_hub.yml` file with the following command: -+ -[source, terminal] ----- -oc edit tackle ----- - -. Enter applicable values for `kai_llm_provider` and `kai_llm_model` variables. -+ -[source, yaml] ----- -kind: Tackle -apiVersion: tackle.konveyor.io/v1alpha1 -metadata: - name: mta - namespace: openshift-mta -spec: - kai_llm_proxy_enabled: true - kai_solution_server_enabled: true - kai_llm_provider: #For example, OpenAI. - # optional, pick a suitable model for your provider - kai_llm_model: ----- -+ - -[NOTE] -==== -For OpenAI models and LLMs deployed in the {ocp-name} AI cluster, enter `OpenAI` as the `kai_llm_provider` value. -==== - -. Apply the Tackle CR by in the `openshift-mta` project using the following command. -+ -[source, terminal] ----- - $ oc apply -f tackle_hub.yaml ----- - -.Verification - -. Enter the following command to verify the {mta-dl-plugin} resources deployed for Solution Server. -+ -[source, terminal] ----- -oc get deploy,svc -n openshift-mta | grep -E 'kai-(api|db|importer)' ----- -+ - -[NOTE] -==== -When you enable Solution Server, the Solution Server API endpoint is served through the {ProductShortName} Hub. You need not complete any further task, such as creating a route for the Solution Server API. -==== diff --git a/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc b/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc index 8ae66e13..a2b21dde 100644 --- a/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc +++ b/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc @@ -8,7 +8,7 @@ [role="_abstract"] To use the LLM proxy service, you must enable the proxy in the Tackle custom resource (CR) and deploy it in the Red Hat {ocp-name} project where you installed the {ProductShortName} Operator. -The proxy authenticates to the LLM in the backend by using the LLM secret configured in the cluster. This helps the Administrator to create, manage, and rotate the LLM key without sharing the key with many client endpoints, for example, {ProductShortName} IDE extension, in the organization. +The proxy authenticates to the LLM in the backend by using the LLM secret that you configured in the cluster. This helps the Administrator to create, manage, and rotate the LLM key without sharing the key with many client endpoints, for example, {ProductShortName} Integrated Development Environment (IDE) extension, in the organization. [NOTE] ==== @@ -17,7 +17,7 @@ To use the Solution Server, the Administrator must enable it in the Tackle CR al .Prerequisites -* You deployed an additional `RWO` volume for the `{mta-dl-plugin}-database` if you want to use {mta-dl-plugin}. See link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] for more information. +* You deployed an additional ReadWriteOnce (`RWO`) volume for the `{mta-dl-plugin}-database` if you want to use {mta-dl-plugin}. See link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] for more information. * You installed the {ProductShortName} Operator v8.1.0 or later. @@ -28,9 +28,9 @@ To use the Solution Server, the Administrator must enable it in the Tackle CR al + . Create the Tackle CR in the `tackle_hub.yaml` file: + -[source, terminal] +[subs="+quotes"] ---- -vi tackle +*vi tackle* ---- . Enable `kai_llm_proxy_enabled` in the Tackle CR: @@ -56,23 +56,23 @@ spec: . Apply the Tackle CR in the `openshift-mta` project: + -[source, terminal] +[subs="+quotes"] ---- - $ oc apply -f tackle_hub.yaml + $ *oc apply -f tackle_hub.yaml* ---- .Verification -. Enter the following command to verify the {mta-dl-plugin} resources deployed for Solution Server. +* Enter the following command to verify the {mta-dl-plugin} resources deployed for Solution Server. + -[source, terminal] +[subs="+quotes"] ---- -oc get deploy,svc -n openshift-mta | grep -E 'kai-(api|db|importer)' +$ *oc get deploy,svc -n openshift-mta | grep -E 'kai-(api|db|importer)'* ---- + [NOTE] ==== -When you enable Solution Server, the Solution Server API endpoint is served through the {ProductShortName} Hub. You need not complete any further task, such as creating a route for the Solution Server API. +When you enable Solution Server, the {ProductShortName} Hub serves the Solution Server API endpoint. You need not complete any further task, such as creating a route for the Solution Server API. ==== diff --git a/docs/topics/developer-lightspeed/proc_tackle-llm-secret.adoc b/docs/topics/developer-lightspeed/proc_tackle-llm-secret.adoc index 46d5aade..46d443f4 100644 --- a/docs/topics/developer-lightspeed/proc_tackle-llm-secret.adoc +++ b/docs/topics/developer-lightspeed/proc_tackle-llm-secret.adoc @@ -24,40 +24,40 @@ You must create a LLM API key secret in your {ocp-name} cluster to produce the r .. For Amazon Bedrock as the provider, type: + -[source, terminal] +[subs="+quotes"] ---- -oc create secret generic aws-credentials \ - --from-literal=AWS_ACCESS_KEY_ID= \ - --from-literal=AWS_SECRET_ACCESS_KEY= +*oc create secret generic aws-credentials* \ + *--from-literal=AWS_ACCESS_KEY_ID=* \ + *--from-literal=AWS_SECRET_ACCESS_KEY=* ---- + .. For Azure OpenAI as the provider, type: + -[source, terminal] +[subs="+quotes"] ---- -oc create secret generic kai-api-keys -n openshift-mta \ - --from-literal=AZURE_OPENAI_API_KEY='' +*oc create secret generic kai-api-keys -n openshift-mta* \ + *--from-literal=AZURE_OPENAI_API_KEY=''* ---- + .. For Google as the provider, type: + -[source, terminal] +[subs="+quotes"] ---- -oc create secret generic kai-api-keys -n openshift-mta \ - --from-literal=GEMINI_API_KEY='' +*oc create secret generic kai-api-keys -n openshift-mta* \ + *--from-literal=GEMINI_API_KEY=''* ---- + .. For the OpenAI-compatible providers, type: + -[source, terminal] +[subs="+quotes"] ---- -oc create secret generic kai-api-keys -n openshift-mta \ - --from-literal=OPENAI_API_BASE='https://example.openai.com/v1' \ - --from-literal=OPENAI_API_KEY='' +*oc create secret generic kai-api-keys -n openshift-mta* \ + *--from-literal=OPENAI_API_BASE='https://example.openai.com/v1'* \ + *--from-literal=OPENAI_API_KEY=''* ---- + [NOTE] @@ -69,9 +69,8 @@ You can also set the base URL as the `kai_llm_baseurl` variable in the Tackle cu . (Optional) Force a reconcile so that the {ProductShortName} operator picks up the secret immediately + -[source, terminal] +[subs="+quotes"] ---- -kubectl patch tackle tackle -n openshift-mta --type=merge -p \ -'{"metadata":{"annotations":{"konveyor.io/force-reconcile":"'"$(date +%s)"'"}}}' ----- -//Is the double tackle needed in the command? +*kubectl patch tackle tackle -n openshift-mta --type=merge -p* \ +*'{"metadata":{"annotations":{"konveyor.io/force-reconcile":"'"$(date +%s)"'"}}}'* +---- \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/ref_dl-benefits.adoc b/docs/topics/developer-lightspeed/ref_dl-benefits.adoc index 488e3baa..ce458b68 100644 --- a/docs/topics/developer-lightspeed/ref_dl-benefits.adoc +++ b/docs/topics/developer-lightspeed/ref_dl-benefits.adoc @@ -2,7 +2,7 @@ // // * docs/cli-guide/master.adoc -:_content-type: REFERENCE +:_mod-docs-content-type: REFERENCE [id="benefits-using-developer-lightspeed_{context}"] = Benefits of using {mta-dl-plugin} @@ -10,12 +10,12 @@ :context: dl-benefits [role=_abstract] -{mta-dl-full} offers options to use large language models of your choice, LLM configuration control, and a platform engineering approach to standardize AI-assisted refactoring efforts for large codebases in your organization. +{mta-dl-full} offers options to use large language models of your choice, LLM configuration control, and a platform engineering approach to standardize AI-assisted refactoring efforts for large codebases in your organization. * *Model agnostic* - {mta-dl-plugin} follows a "Bring Your Own Model" approach, allowing your organization to use a preferred LLM. * *Iterative refinement* - {mta-dl-plugin} can include an agent that iterates through the source code to run a series of automated analyses that resolves both the code base and diagnostic issues. -* *Contextual code generation* - By leveraging AI for static code analysis, {mta-dl-plugin} breaks down complex problems into more manageable ones, providing the LLM with focused context to generate meaningful results. This helps overcome the limited context size of LLMs when dealing with large codebases. +* *Contextual code generation* - {mta-dl-plugin} breaks down complex problems into more manageable ones, providing the LLM with focused context to generate meaningful results. This helps overcome the limited context size of LLMs when dealing with large codebases. * *No fine tuning* - You also do not need to fine tune your model with a suitable data set for analysis which leaves you free to use and switch LLM models to respond to your requirements. -* *Learning and Improvement* - As more parts of a codebase are migrated with {mta-dl-plugin}, it can use RAG to learn from the available data and provide better recommendations in subsequent application analysis. +* *Learning and Improvement* - As {mta-dl-plugin} migrates more parts of a codebase, it can use RAG to learn from the available data and give better recommendations in subsequent application analysis. -:!dl-benefits: \ No newline at end of file +:!dl-benefits: diff --git a/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc b/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc index 51bf018d..44410f46 100644 --- a/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc +++ b/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc @@ -6,7 +6,7 @@ = Generating code fix suggestions [role="_abstract"] -This example will walk you through generating code fixes for a Java application that must be migrated to the target technology `quarkus`. To generate resolutions for issues in the code, we use the Agentic AI mode and the `my-model` as the large language model (LLM) that you deployed in {ocp-name} AI. +Generate code fixes for a Java application you want to migrate to the target technology `quarkus`. To stream code changes that resolve issues in the code, use the Agent mode and the `my-model` as the large language model (LLM) that you deployed in {ocp-name} AI. .Procedure @@ -51,20 +51,20 @@ models: You must change the `provider-setting` configuration if you plan to use a different LLM provider. ==== -. On the `{ProductShortName}: Open Analysis View` page, click *Start* to start the {ProductShortName} RPC server. +. On the `{ProductShortName}: Open Analysis View` page, click *Start* to start the {ProductShortName} Remote Procedure Call (RPC) server. . Select the profile you configured and click *Run Analysis* to scan the Java application. + {ProductShortName} identifies the issues in the code. -. Click the solutions icon (image:solutions-icon-new.png[Click solutions icon]) in an issue to request suggestions to resolve the issue. +. Click the solutions icon (image:solutions-icon-new.png["Click solutions icon"]) in an issue to request suggestions to resolve the issue. + -{mta-dl-plugin} streams the issue description, a preview of the code changes that resolve the issue, and the file(s) in which the changes are to be made. +{mta-dl-plugin} streams the issue description, a preview of the code changes in files that resolve the issue. + You can review the code changes in the editor and accept or reject the changes. If you accept the changes, {mta-dl-plugin} creates a new file with the accepted code changes. + . Click *Continue* to allow {mta-dl-plugin} to run a follow-up analysis. + -This round of analysis detects lint issues, compilation issues, or diagnostic issues that may have occurred when you accepted the suggested code change. +This round of analysis detects lint issues, compilation issues, or diagnostic issues that can occur when you accepted the suggested code change. + -Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you allow until all issues are resolved. \ No newline at end of file +Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you allow until it resolves all issues. \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc b/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc index b5fc45b4..3dc44e15 100644 --- a/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc +++ b/docs/topics/developer-lightspeed/ref_llm-provider-configurations.adoc @@ -9,9 +9,9 @@ [role="_abstract"] {mta-dl-full} is large language model (LLM) agnostic and integrates with an LLM of your choice. To enable {mta-dl-plugin} to access your large language model (LLM), you must enter the LLM provider configurations in the `provider-settings.yaml` file. -The `provider-settings.yaml` file contains a list of LLM providers that are supported by default. The mandatory environment variables are different for each LLM provider. Depending on the provider that you choose, you can configure additional environment variables for a model in the `provider-settings.yaml` file. You can also enter a new provider with the required environment variables, the base URL, and the model name. +The `provider-settings.yaml` file has a list of LLM providers that {mta-dl-plugin} supports by default. The mandatory environment variables are different for each LLM provider. Depending on the provider that you choose, you can configure additional environment variables for a model in the `provider-settings.yaml` file. You can also enter a new provider with the required environment variables, the base URL, and the model name. -The provider settings file is available in the {mta-dl-plugin} Visual Studio Code extension. +You can find the provider settings file in the {mta-dl-plugin} Visual Studio Code extension. Access the `provider-settings.yaml` from the Visual Studio Code Command Palette by typing `Open the GenAI model provider configuration file`. @@ -22,7 +22,6 @@ You can select one provider from the list by using the `&active` anchor in the n For a model named "my-model" deployed in {ocp-name} AI with "example-model" as the serving name: -//check if openshift prefix is required for OpenShift AI model provider, like "openshift-example-model" or can it be just "example-model" [source, yaml] ---- models: @@ -88,7 +87,7 @@ AmazonBedrock: &active [NOTE] ==== -It is recommended to use the link:https://aws.amazon.com/cli/[AWS CLI] and verify that you have command line access to AWS services before you proceed with the `provider-settings` configurations. +You can use the AWS CLI to verify that you have command line access to AWS services before you proceed with the `provider-settings` configurations. ==== @@ -115,3 +114,7 @@ models: model: "granite-code:8b-instruct" baseUrl: "127.0.0.1:11434" # example URL ---- + +.Additional resources + +* link:https://aws.amazon.com/cli/[AWS CLI] \ No newline at end of file diff --git a/docs/topics/important-links.adoc b/docs/topics/important-links.adoc index 4fc91239..de7373ce 100644 --- a/docs/topics/important-links.adoc +++ b/docs/topics/important-links.adoc @@ -3,7 +3,7 @@ // * docs/cli-guide/master.adoc // * docs/maven-guide/master.adoc -:_content-type: REFERENCE +:_mod-docs-content-type: REFERENCE [id="important-links_{context}"] = {ProductName} development resources diff --git a/docs/topics/mta-cli/con_intro-to-the-cli.adoc b/docs/topics/mta-cli/con_intro-to-the-cli.adoc index 35f09359..864f84d5 100644 --- a/docs/topics/mta-cli/con_intro-to-the-cli.adoc +++ b/docs/topics/mta-cli/con_intro-to-the-cli.adoc @@ -2,7 +2,7 @@ // // * docs/cli-guide/master.adoc -:_content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="intro-to-the-cli_{context}"] = Introduction to the {ProductShortName} command-line interface @@ -24,7 +24,9 @@ You can use the {ProductShortName} to analyze applications written in the follow [IMPORTANT] ==== [subs="attributes+"] -{FeatureName} is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA. +{FeatureName} is Developer Preview software only. Developer Preview software is not supported by Red{nbsp}Hat in any way and is not functionally complete or production-ready. Do not use Developer Preview software for production or business-critical workloads. Developer Preview software provides early access to upcoming product software in advance of its possible inclusion in a Red{nbsp}Hat product offering. Customers can use this software to test functionality and provide feedback during the development process. This software might not have any documentation, is subject to change or removal at any time, and has received limited testing. Red{nbsp}Hat might provide ways to submit feedback on Developer Preview software without an associated SLA. + +For more information about the support scope of Red{nbsp}Hat Developer Preview software, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope] ==== :!FeatureName: diff --git a/docs/topics/mta-cli/proc_accessing-analysis-report.adoc b/docs/topics/mta-cli/proc_accessing-analysis-report.adoc index adabfc72..2803a27e 100644 --- a/docs/topics/mta-cli/proc_accessing-analysis-report.adoc +++ b/docs/topics/mta-cli/proc_accessing-analysis-report.adoc @@ -20,4 +20,4 @@ Report created: __/index.html Access it at this URL: file:///__/index.html .... + -Alternatively, press *Ctrl* and click on the path of the `index.html` file. +Alternatively, press *Ctrl* and click the path of the `index.html` file. diff --git a/docs/topics/mta-cli/proc_analyze-unsupported-provider.adoc b/docs/topics/mta-cli/proc_analyze-unsupported-provider.adoc index 97cf4faf..004eefc2 100644 --- a/docs/topics/mta-cli/proc_analyze-unsupported-provider.adoc +++ b/docs/topics/mta-cli/proc_analyze-unsupported-provider.adoc @@ -8,7 +8,7 @@ [role="_abstract"] To estimate the migration effort for applications built with technologies not natively supported by the {ProductFullName} command-line interface, analyze the source code. The analysis generates a report containing the details of the application migration effort, including potential migration issues. You can use the report to prioritize tasks and estimate the resources needed for the migration. -To run the analysis for an unsupported language provider, you must overwrite the existing supported language provider with your own unsupported language provider. +To run the analysis for an unsupported language provider, you must overwrite the existing supported language provider with your own unsupported language provider. IMPORTANT: You must create a configuration file for your unsupported language provider before overriding the supported provider. @@ -17,7 +17,8 @@ IMPORTANT: You must create a configuration file for your unsupported language pr * You created a configuration file for your unsupported language provider, for example: + -.... +[source,yaml] +---- [ { "name": "java", @@ -32,7 +33,7 @@ IMPORTANT: You must create a configuration file for your unsupported language pr }] } ] -.... +---- .Procedure diff --git a/docs/topics/mta-cli/proc_analyzing-app-with-profile.adoc b/docs/topics/mta-cli/proc_analyzing-app-with-profile.adoc index ca522cc4..5fd5e3ea 100644 --- a/docs/topics/mta-cli/proc_analyzing-app-with-profile.adoc +++ b/docs/topics/mta-cli/proc_analyzing-app-with-profile.adoc @@ -21,54 +21,55 @@ Migrators can use analysis profiles and custom rules downloaded from the {Produc + [subs="+quotes"] ---- -$ mta-cli config login +$ *mta-cli config login* ---- -+ + . Enter the `Host`, `Username`, and `Password` to connect to the Hub. + - [subs="+quotes"] ---- -$ mta-cli config login +$ *mta-cli config login* +---- ++ +[subs="+quotes"] +---- Host: https://mta-namespace.apps.cluster.example.com/hub Username: __ Password: __ ---- -+ -[NOTE] -==== + * The `Host` is the `tackle` URL of {ProductShortName} deployed in your cluster that exposes the `hub` endpoint. * The `Username` and `Password` are the `keycloak` credentials that you use to log in to {ProductShortName} in your cluster. -==== -+ -. Sync the application with its remote repository and download the profile and custom rules files from the Hub. + +. Sync the application with its remote repository and download the profile and custom rules files from the Hub. + -[subs="+quotes"] +[subs="+quotes, macros"] .... -$ mta-cli config sync --url https://github.com/ --application-path __ --insecure +$ *mta-cli config sync --url \https://github.com/__ --application-path __ --insecure* .... + [NOTE] ==== {ProductShortName} downloads the profile and custom rule files in the `.konveyor/profiles/` path in your local application. ==== -+ + . Check the path where {ProductShortName} downloaded the configuration: + [subs="+quotes"] ---- -$ mta-cli config list --profile-dir __ +$ *mta-cli config list --profile-dir __* ---- + . Run an analysis by using the downloaded profile configuration. + [subs="+quotes"] ---- -$ mta-cli analyze -i __ -o __ --overwrite --mode source-only +$ *mta-cli analyze -i __ -o __ --overwrite --mode source-only* ---- + [TIP] ==== -For Java applications, you can use the `full` mode while running an analysis. For non-Java applications, the analysis mode must be `source-only`. +For Java applications, use the `full` mode while running an analysis. For non-Java applications, the analysis mode must be `source-only`. ==== + [NOTE] @@ -77,7 +78,7 @@ The following command overrides the values of `target` in the analysis profile w [subs="+quotes"] ---- -mta-cli analyze -i __ -o __ --overwrite --target quarkus --mode source-only +$ *mta-cli analyze -i __ -o __ --overwrite --target quarkus --mode source-only* ---- ==== diff --git a/docs/topics/mta-cli/proc_analyzing-multiple-apps-with-mta-cli.adoc b/docs/topics/mta-cli/proc_analyzing-multiple-apps-with-mta-cli.adoc index 13e19b54..c79bdb33 100644 --- a/docs/topics/mta-cli/proc_analyzing-multiple-apps-with-mta-cli.adoc +++ b/docs/topics/mta-cli/proc_analyzing-multiple-apps-with-mta-cli.adoc @@ -13,7 +13,9 @@ To efficiently assess the migration effort for a portfolio of applications, you [IMPORTANT] ==== [subs="attributes+"] -{FeatureName} is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA. +{FeatureName} is Developer Preview software only. Developer Preview software is not supported by Red{nbsp}Hat in any way and is not functionally complete or production-ready. Do not use Developer Preview software for production or business-critical workloads. Developer Preview software provides early access to upcoming product software in advance of its possible inclusion in a Red{nbsp}Hat product offering. Customers can use this software to test functionality and provide feedback during the development process. This software might not have any documentation, is subject to change or removal at any time, and has received limited testing. Red{nbsp}Hat might provide ways to submit feedback on Developer Preview software without an associated SLA. + +For more information about the support scope of Red{nbsp}Hat Developer Preview software, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope]. ==== :!FeatureName: diff --git a/docs/topics/mta-cli/proc_analyzing-single-app-with-mta-cli.adoc b/docs/topics/mta-cli/proc_analyzing-single-app-with-mta-cli.adoc index c0d8d5c5..5d6fa4cb 100644 --- a/docs/topics/mta-cli/proc_analyzing-single-app-with-mta-cli.adoc +++ b/docs/topics/mta-cli/proc_analyzing-single-app-with-mta-cli.adoc @@ -56,7 +56,7 @@ Report created: __/index.html .. Paste the path to the browser of your choice. + -Alternatively, press *Ctrl* and click on the path to the report file. +Alternatively, press *Ctrl* and click the path of the `index.html` file. [role="_additional-resources"] .Additional resources diff --git a/docs/topics/mta-cli/proc_assets-generation-example.adoc b/docs/topics/mta-cli/proc_assets-generation-example.adoc index 18518d09..0af487b1 100644 --- a/docs/topics/mta-cli/proc_assets-generation-example.adoc +++ b/docs/topics/mta-cli/proc_assets-generation-example.adoc @@ -34,6 +34,10 @@ Assume that the `cf-nodejs-app.yaml` is located in the same directory as the {Pr [subs="+quotes"] ---- $ *cat cf-nodejs-app.yaml* +---- ++ +[subs="+quotes"] +---- name: cf-nodejs lifecycle: cnb buildpacks: @@ -58,6 +62,10 @@ $ *mta-cli discover cloud-foundry \ [subs="+quotes"] ---- $ *cat discover.yaml* +---- ++ +[subs="+quotes"] +---- name: cf-nodejs randomRoute: true timeout: 60 @@ -81,6 +89,10 @@ $ *mta-cli generate helm \ [subs="+quotes"] ---- $ *cat ./newDir/Dockerfile* +---- ++ +[subs="+quotes"] +---- FROM busybox:latest RUN echo "Hello cf-nodejs!" @@ -91,6 +103,10 @@ RUN echo "Hello cf-nodejs!" [subs="+quotes"] ---- $ *cat ./newDir/configmap.yaml* +---- ++ +[subs="+quotes"] +---- apiVersion: v1 kind: ConfigMap metadata: @@ -120,6 +136,10 @@ $ *mta-cli generate helm \ [subs="+quotes"] ---- $ *cat ./newDir/configmap.yaml* +---- ++ +[subs="+quotes"] +---- apiVersion: v1 kind: ConfigMap metadata: diff --git a/docs/topics/mta-cli/proc_concealing-sensitive-information.adoc b/docs/topics/mta-cli/proc_concealing-sensitive-information.adoc index 2b5369a7..f29587b6 100644 --- a/docs/topics/mta-cli/proc_concealing-sensitive-information.adoc +++ b/docs/topics/mta-cli/proc_concealing-sensitive-information.adoc @@ -23,6 +23,10 @@ NOTE: If you do not specify the `--conceal-sensitive-data` option, the option is [subs="+quotes"] .... $ *cat __.yaml* +.... ++ +[subs="+quotes"] +.... name: __ disk_quota: 512M memory: 500M @@ -47,6 +51,10 @@ $ *mta-cli discover cloud-foundry --conceal-sensitive-data=true --input __* +.... ++ +[subs="+quotes"] +.... __ ├── discover_manifestpass:[_]__.yaml ├── secretspass:[_]__.yaml @@ -59,6 +67,10 @@ __ [subs="+quotes"] .... $ *cat __.yaml* +.... ++ +[subs="+quotes"] +.... name: __ timeout: 10 docker: @@ -77,6 +89,10 @@ The sensitive data was replaced with a UUID (Universally Unique Identifier). [subs="+quotes,macros"] .... $ *cat secretspass:[_]__.yaml* +.... ++ +[subs="+quotes"] +.... f0e9ea9e-1913-446f-8483-da9301373eef: docker-registry-user .... + diff --git a/docs/topics/mta-cli/proc_generate_deployment_assets_values_file.adoc b/docs/topics/mta-cli/proc_generate_deployment_assets_values_file.adoc index 9bb1e66d..be256a18 100644 --- a/docs/topics/mta-cli/proc_generate_deployment_assets_values_file.adoc +++ b/docs/topics/mta-cli/proc_generate_deployment_assets_values_file.adoc @@ -7,12 +7,12 @@ = Generating deployment manifests from a discovery manifest and values.yaml [role="_abstract"] -Use a Helm chart and a `values.yaml` file to generate deployment manifests that include configuration keys missing from a discovery manifest. This process allows you to capture additional metadata or use the `--set` flag to override values and customize your generated assets. +Use a Helm chart and a `values.yaml` file to generate deployment manifests that include configuration keys in addition to the discovery manifest. You can capture additional metadata or use the `--set` flag to override values and customize your generated assets. .Prerequisites * You installed the `Helm` command-line interface (CLI). -* To use Helm templates to generate assets, you saved your files in the Helm chart root directory as follows: +* You saved your files in the Helm chart root directory as follows: ** You saved Kubernetes YAML templates, for example, `ConfigMap` or `Deployment`, in the `templates` directory. ** You saved non-Kubernetes templates, for example, `Dockerfile`, in the `files/konveyor` path. ** You saved the `values.yaml` file in the root directory. @@ -64,15 +64,14 @@ $ *mta-cli generate helm --chart-dir __* \ + where: -`__`:: Specifies the directory containing the Helm chart. -`__`:: Specifies the location of the discovery manifest file. `__`:: Specifies the output directory for the generated manifests. + + -The variable priority hierarchy for generating deployment manifests is as follows: +The variable priority for generating deployment manifests is as follows: -* **Priority 1: The `--set` command flag**: Any value specified with this flag has the highest priority and overrides variables defined in either the `values.yaml` file or the discovery manifest. -* **Priority 2: The discovery manifest**: If you do not use the `--set` flag, the discovery manifest configuration is used as the primary input for generation. -* **Priority 3: The `values.yaml` file**: If this file is not empty, it provides the input values. However, if a key exists in both the discovery manifest and the `values.yaml` file, the value from the discovery manifest takes precedence. +* **Priority 1 - The `--set` command flag**: Any value specified with this flag has the highest priority and overrides variables defined in either the `values.yaml` file or the discovery manifest. +* **Priority 2 - The discovery manifest**: If you do not use the `--set` flag, the discovery manifest configuration is used as the primary input for asset generation. +* **Priority 3 - The `values.yaml` file**: If this file is not empty, the generated assets include the input values from this file. However, if a key exists in both the discovery manifest and the `values.yaml` file, the value from the discovery manifest takes precedence. .Verification diff --git a/docs/topics/mta-cli/proc_generating-deployment-manifest.adoc b/docs/topics/mta-cli/proc_generating-deployment-manifest.adoc index 89c2c064..a356cc32 100644 --- a/docs/topics/mta-cli/proc_generating-deployment-manifest.adoc +++ b/docs/topics/mta-cli/proc_generating-deployment-manifest.adoc @@ -4,12 +4,21 @@ :_mod-docs-content-type: PROCEDURE [id="generating-deployment-manifest_{context}"] -= Generating a deployment manifest += Generating a deployment manifest by using a discovery manifest [role="_abstract"] -To prepare your application for deployment to a container platform, generate a deployment manifest by using the {ProductFullName} command-line interface (CLI). Generating the deployment manifest creates the necessary configuration files to define your application's resources, streamlining the transition to your target environment. +To prepare your application for deployment to a container platform, generate a deployment manifest by using a discovery manifest with the {ProductFullName} command-line interface (CLI). Generating the deployment manifest creates the necessary configuration files to define your application's resources, streamlining the transition to your target environment. + +You can auto-generate the {ocp-full} deployment manifest for the Cloud Foundry (CF) application by using the `generate` command. Based on the Helm template that you provide, the command generates manifests, such as a ConfigMap, and non-Kubernetes manifests, such as a Dockerfile, for application deployment. + +As an Architect, you can generate application assets by using only source code, without generating a discovery manifest first. If the discovery manifest is unavailable, the generator uses the following implicit data from the application profile for opinionated asset generation: + +* *Application metadata:* Information such as the application name, version, and unique identifiers. +* *Application archetypes:* Standardized templates or structures identified during the initial analysis. +* *Identified application tags:* Logic must be applied based on the tags found during analysis. For example: +** For Quarkus, configure specific environment variables for native-mode deployments. +** For Spring Boot, apply standard Spring framework configurations and dependencies to the generated manifests. -You can auto-generate the {ocp-full} deployment manifest for the Cloud Foundry (CF) application by using the `generate` command. Based on the Helm template that you provide, the command generates manifests, such as a ConfigMap, and non-Kubernetes manifests, such as a Dockerfile, for application deployment. .Prerequisites @@ -24,7 +33,7 @@ You can auto-generate the {ocp-full} deployment manifest for the Cloud Foundry ( . Open the terminal application and navigate to the `<{ProductShortName}_HOME>/` directory. -. Generate the deployment manifest as an output file: +. Generate the deployment manifest as an output file from the discovery manifest: + [subs="+quotes"] ---- @@ -37,15 +46,23 @@ $ *mta-cli generate helm --chart-dir helm_sample \ + [subs="+quotes"] ---- -$ *mta-cli cd __ \* +$ *mta-cli cd __* +---- ++ +[subs="+quotes"] +---- $ *cat configmap.yaml* -$ *cat Dockerfile* ---- + . Verify the Dockerfile: + [subs="+quotes"] ---- -$ *mta-cli cd __ \* +$ *mta-cli cd __* +---- ++ +[subs="+quotes"] +---- $ *cat Dockerfile* ---- diff --git a/docs/topics/mta-cli/proc_performing-a-live-discovery.adoc b/docs/topics/mta-cli/proc_performing-a-live-discovery.adoc index 055f5ec2..3d172baa 100644 --- a/docs/topics/mta-cli/proc_performing-a-live-discovery.adoc +++ b/docs/topics/mta-cli/proc_performing-a-live-discovery.adoc @@ -35,6 +35,10 @@ IMPORTANT: You must enter at least one Cloud Foundry organization by using the ` [subs="+quotes"] .... $ *cf spaces* +.... ++ +[subs="+quotes"] +.... $ *cf apps* .... diff --git a/docs/topics/mta-cli/proc_reviewing-analysis-issues-and-incidents.adoc b/docs/topics/mta-cli/proc_reviewing-analysis-issues-and-incidents.adoc index 7b5f28ea..e010669e 100644 --- a/docs/topics/mta-cli/proc_reviewing-analysis-issues-and-incidents.adoc +++ b/docs/topics/mta-cli/proc_reviewing-analysis-issues-and-incidents.adoc @@ -12,10 +12,10 @@ Each issue contains a list of files where a rule matched one or more times. Thes .Procedure -. Open the analysis report. For more information, see xref:accessing-analysis-report_reviewing-analysis-reports[Accessing an analysis report]. +. Open the analysis report. . Click *Issues*. -. Click on the issue you want to check. -. Under the *File* tab, click on a file to display an incident or incidents that triggered the issue. +. Click the issue you want to check. +. Under the File tab, click a file to display the incidents that triggered the issue. . Display the incident message by hovering over the line that triggered the incident, for example: + [subs="+quotes"] @@ -46,4 +46,6 @@ Use the Quarkus Maven plugin adding the following sections to the pom.xml file: .... - +[role="_additional-resources"] +.Additional resources +* xref:accessing-analysis-report_reviewing-analysis-reports[Accessing an analysis report] diff --git a/docs/topics/mta-cli/proc_running-the-containerless-mta-cli.adoc b/docs/topics/mta-cli/proc_running-the-containerless-mta-cli.adoc index 2dff160b..9d80755c 100644 --- a/docs/topics/mta-cli/proc_running-the-containerless-mta-cli.adoc +++ b/docs/topics/mta-cli/proc_running-the-containerless-mta-cli.adoc @@ -6,11 +6,11 @@ = Analyzing an application in containerless mode [role="_abstract"] -To analyze applications in environments where a container engine is not available or desired, you can run the {ProductFullName} command-line interface (CLI) in containerless mode. This way, you can execute assessments directly on your local machine by using the provided shell script, bypassing the need for Podman or Docker. +To analyze applications in environments where a container engine is not available or needed, you can run the {ProductFullName} command-line interface (CLI) in containerless mode. This way, you can run assessments directly on your local machine by using the provided shell script, bypassing the need for Podman or Docker. [IMPORTANT] ==== -In {ProductShortName} 7.2.0 and later, containerless CLI is a default mode. To enable container runtime usage for the analysis of Java applications, you must set the `--run-local` flag to `false`: +Containerless CLI is the default mode. To enable container runtime usage for the analysis of Java applications, you must set the `--run-local` flag to `false`: ---- --run-local=false @@ -21,7 +21,7 @@ The analysis for other applications runs in the container mode automatically. .Prerequisites -* You installed the {ProductShortName} CLI. For more information, see link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#installing-cli-zip_installing-mta-cli[Installing the CLI by using a .zip file]. +* You installed the {ProductShortName} CLI. * You installed Java Development Kit (JDK) version 17 or later. * If you use OpenJDK on Red Hat Enterprise Linux (RHEL) or Fedora, you installed the Java `devel` package. * You installed Maven version 3.9.9 or later. @@ -32,10 +32,10 @@ The analysis for other applications runs in the container mode automatically. * You set the `JVM_MAX_MEM` system variable. + NOTE: If you do not set `JVM_MAX_MEM`, the analysis might hang because Java might require more memory than the default `JVM_MAX_MEM` value. -* For Gradle analysis: +* For Gradle analysis, you completed the following steps: ** You installed OpenJDK version 8. ** You set `$JAVA8_HOME` and it is pointing to the OpenJDK 8 home directory. -** Your project has a link:https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper]. +** Your project has a Gradle Wrapper. .Procedure @@ -61,3 +61,4 @@ NOTE: The `--overwrite` option overwrites the output folder if it exists. * link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#installing-cli-zip_installing-mta-cli[Installing the CLI by using a .zip file] * xref:mta-cli-analyze-flags_analyzing-applications-mta-cli[The mta-cli analyze command options] +* link:https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle Wrapper] diff --git a/docs/topics/mta-cli/ref_analysis-report-sections.adoc b/docs/topics/mta-cli/ref_analysis-report-sections.adoc index d0a6b6cd..b68492dd 100644 --- a/docs/topics/mta-cli/ref_analysis-report-sections.adoc +++ b/docs/topics/mta-cli/ref_analysis-report-sections.adoc @@ -31,7 +31,7 @@ For more information about the support scope of Red Hat Technology Preview featu |Technologies|All embedded libraries grouped by functionality. Use this report to display the technologies used in each application. |Insights|Information about a violation generated by a rule with zero effort. Issues are generated by general rules, whereas string tags are generated by the tagging rules. String tags indicate the presence of a technology but do not show the code location. Insights contain information about the technologies used in the application and their usage in the code. -Insights do not impact the migration. For example, a rule searching for deprecated API usage in the code that does not impact the current migration but can be tracked and fixed when needed in the future. +Insights do not impact the migration. For example, a rule searching for deprecated API usage in the code that does not impact the current migration but can be tracked and fixed when needed in the future. Unlike with issues, you do not need to fix insights for a successful migration. They are generated by any rule that does not have a positive effort value and category assigned. They might have a message and tag. |==== diff --git a/docs/topics/mta-cli/ref_available-openrewrite-recipes.adoc b/docs/topics/mta-cli/ref_available-openrewrite-recipes.adoc index 0154a7c7..b12f2b65 100644 --- a/docs/topics/mta-cli/ref_available-openrewrite-recipes.adoc +++ b/docs/topics/mta-cli/ref_available-openrewrite-recipes.adoc @@ -13,7 +13,7 @@ The {ProductFullName} command-line interface (CLI) provides `OpenRewrite` recipe [options="header"] |==== |Migration path|Purpose|The `rewrite.config` file location|Active recipes -|Java EE to Jakarta EE|Replace import of `javax` packages with equivalent `jakarta` packages. +|Java EE to Jakarta EE|Replace import of `javax` packages with equivalent `jakarta` packages. Replace `javax` artifacts, declared within `pom.xml` files, with the `jakarta` equivalents.|`__/rules/openrewrite/jakarta \ /javax/imports/rewrite.yml`|`org.jboss.windup.JavaxToJakarta` |Java EE to Jakarta EE |Rename bootstrapping files.|`__/rules/openrewrite/jakarta \ /javax/bootstrapping/rewrite.yml`|`org.jboss.windup.jakarta.javax. \ BootstrappingFiles` diff --git a/docs/topics/mta-cli/ref_discover-generate-command-options.adoc b/docs/topics/mta-cli/ref_discover-generate-command-options.adoc index 47864c43..59539a58 100644 --- a/docs/topics/mta-cli/ref_discover-generate-command-options.adoc +++ b/docs/topics/mta-cli/ref_discover-generate-command-options.adoc @@ -60,7 +60,7 @@ a|Specify the location of the YAML manifest file to discover the CF applications * A path to the directory with multiple manifest files. a|`--output` -a|Specify the location to save the __.yaml file. +a|Specify the location to save the `__.yaml` file. a|`--spaces` a|A comma-separated list of Cloud Foundry spaces to analyze during a live discovery, for example: @@ -91,7 +91,7 @@ a|`--chart-dir` a|Specify a directory that contains the Helm chart. a|`--input` -a|Specify a location of the __.yaml file to generate the deployment manifest. +a|Specify a location of the `__.yaml` file to generate the deployment manifest. a|`--non-k8s-only` a|Generate only non-Kubernetes templates, such as a Dockerfile. diff --git a/docs/topics/mta-cli/ref_discovery_manifest_sample.adoc b/docs/topics/mta-cli/ref_discovery_manifest_sample.adoc index b00f24b4..bd82740e 100644 --- a/docs/topics/mta-cli/ref_discovery_manifest_sample.adoc +++ b/docs/topics/mta-cli/ref_discovery_manifest_sample.adoc @@ -3,13 +3,18 @@ :_mod-docs-content-type: REFERENCE -[id="discover-manifest-sample_{context}"] +[id="discovery-manifest-sample_{context}"] = Example discovery manifest [role="_abstract"] You can use the following discovery manifest template as a reference to make sure that the discovery manifest generated by {ProductShortName} has all the necessary fields. -[source, yaml] +[NOTE] +==== +You must configure the `buildPacks` in the Cloud Foundry application manifest to include the `buildPacks` in the discovery and deployment assets. +==== + +[source,yaml] ---- manifest: appName: my-app @@ -43,9 +48,4 @@ manifest: buildPacks: - docker://my-registry-a.corp/nodejs - docker://my-registry-b.corp/dynatrace ----- - -[NOTE] -==== -You must configure the `buildPacks` in the Cloud Foundry application manifest to include the `buildPacks` in the discovery and deployment assets. -==== \ No newline at end of file +---- \ No newline at end of file diff --git a/docs/topics/mta-cli/ref_effort-level-estimation.adoc b/docs/topics/mta-cli/ref_effort-level-estimation.adoc index 3c6d98cc..d0e8fbba 100644 --- a/docs/topics/mta-cli/ref_effort-level-estimation.adoc +++ b/docs/topics/mta-cli/ref_effort-level-estimation.adoc @@ -4,7 +4,7 @@ // * docs/maven-guide/master.adoc // * docs/rules-development-guide/master.adoc -:_content-type: REFERENCE +:_mod-docs-content-type: REFERENCE [id="effort-level-estimation_{context}"] = Guidelines for the level of effort estimation diff --git a/docs/topics/mta-cli/ref_modify-application-profile.adoc b/docs/topics/mta-cli/ref_modify-application-profile.adoc index 80e6ca40..0dc0996d 100644 --- a/docs/topics/mta-cli/ref_modify-application-profile.adoc +++ b/docs/topics/mta-cli/ref_modify-application-profile.adoc @@ -6,7 +6,7 @@ = A sample profile configuration [role="_abstract"] -After Migrators download the analysis profile from the Hub, they can modify the configuration before running an analysis. +After Migrators download the analysis profile from the Hub, they can modify the configuration before running an analysis. When you sync the profile, the {ProductShortName} {CLIName} overrides the modified configuration by downloading the latest configuration from the Hub to your local application. @@ -46,31 +46,31 @@ rules: name: "" repository: kind: git - url: + url: URL branch: "" tag: "" path: default/generated ---- where -`id` :: specifies the unique identifier of the analysis profile. +`id`:: Specifies the unique identifier of the analysis profile. -`createUser` :: specifies the user who created the analysis profile in the Hub. +`createUser`:: Specifies the user who created the analysis profile in the Hub. -`createTime` :: specifies the date and time when the user created the profile. +`createTime`:: Specifies the date and time when the user created the profile. -`name` :: specifies the name of the analysis profile. +`name`:: Specifies the name of the analysis profile. -`withDeps` :: specifies if {ProductShortName} includes dependencies in the analysis as a boolean value. +`withDeps`:: Specifies if {ProductShortName} includes dependencies in the analysis as a boolean value. -`withKnownLibs` :: specifies if {ProductShortName} includes known open-source libraries in the analysis. +`withKnownLibs`:: Specifies if {ProductShortName} includes known open-source libraries in the analysis. -`packages` :: specifies the packages that are included and excluded in the analysis. +`packages`:: Specifies the packages that are included and excluded in the analysis. -`targets` :: specifies a unique id and name of each migration target in the analysis profile. +`targets`:: Specifies a unique id and name of each migration target in the analysis profile. -`labels` :: specifies the labels that filters rules that are applied and excluded in the analysis. +`labels`:: Specifies the labels that filters rules that are applied and excluded in the analysis. -`files` :: specifies the unique identifier and name of a custom rule in a file. The {ProductShortName} {CLIName} uses the file directly in an analysis. +`files`:: Specifies the unique identifier and name of a custom rule in a file. The {ProductShortName} {CLIName} uses the file directly in an analysis. -`repository` :: specifies details of external ruleset repository. For example, `kind` (`Git` or `Subversion`), `URL`, `branch`, `tag`, and `path` within the repository to the rulesets. \ No newline at end of file +`repository`:: Specifies details of external ruleset repository. For example, `kind` (`Git` or `Subversion`), `URL`, `branch`, `tag`, and `path` within the repository to the rulesets. \ No newline at end of file diff --git a/docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc b/docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc index a8e38ea6..b66c32e8 100644 --- a/docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc +++ b/docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc @@ -14,8 +14,8 @@ You can customize the application analysis process with {ProductFullName} comman |==== |Option|Description |`--analyze-known-libraries` (bool)|Analyze open-source libraries. -|`--disable-maven-search`| Set `--disable-maven-search=true` to disable {ProductShortName} from relying on the Maven search index to determine if a dependency is publicly available, such as an open-source dependency, or internal to the Java binary application during analysis. - +|`--disable-maven-search`| Set `--disable-maven-search=true` to disable {ProductShortName} from relying on the Maven search index to determine if a dependency is publicly available, such as an open-source dependency, or internal to the Java binary application during analysis. + When you disable Maven search, {ProductShortName} at first tries to determine dependencies from the JAR file's POM file, if any. If this method does not succeed, {ProductShortName} goes through the directory structure to determine dependencies. This method may not produce a reliable dependency classification since the package structure can differ from what is expected by {ProductShortName}. You might see more incidents because some dependencies may be wrongly classified as internal. By default, `--disable-maven-search=false`. Therefore, {ProductShortName} uses the SHA digest of the JAR file to search the Maven search index. This setting generates more accurate dependencies but the drawback is that the Maven search index is frequently unavailable. diff --git a/docs/topics/mta-cli/ref_mta-tech-tags.adoc b/docs/topics/mta-cli/ref_mta-tech-tags.adoc index 10b355d4..dbd34eec 100644 --- a/docs/topics/mta-cli/ref_mta-tech-tags.adoc +++ b/docs/topics/mta-cli/ref_mta-tech-tags.adoc @@ -2,7 +2,7 @@ // // * docs/cli-guide/master.adoc -:_content-type: REFERENCE +:_mod-docs-content-type: REFERENCE [id="mta-tech-tags_{context}"] = Supported technology tags @@ -149,7 +149,7 @@ View the {ProductFullName} technology tags supported by the {ProductShortName} c * JBehave * JBoss Cache * JBoss EJB XML -* JBoss logging +* JBoss Logging * JBoss Transactions * JBoss Web XML * JBossMQ Client diff --git a/docs/topics/mta-cli/ref_openrewrite-command-options.adoc b/docs/topics/mta-cli/ref_openrewrite-command-options.adoc index 2010ee5b..906af979 100644 --- a/docs/topics/mta-cli/ref_openrewrite-command-options.adoc +++ b/docs/topics/mta-cli/ref_openrewrite-command-options.adoc @@ -8,7 +8,7 @@ [role="_abstract"] The {ProductFullName} command-line interface (CLI) provides the `mta-cli transform openrewrite` command options to customize the transformation of your application source code. Check the following table to identify the available arguments for applying specific migration recipes and controlling the output of the transformation process. -.The mta-cli transform openrewrite command options +.The `mta-cli transform openrewrite` command options [options="header"] |==== |Option|Description diff --git a/docs/topics/mta-cli/ref_supported-migration-paths.adoc b/docs/topics/mta-cli/ref_supported-migration-paths.adoc index b24885c9..77421897 100644 --- a/docs/topics/mta-cli/ref_supported-migration-paths.adoc +++ b/docs/topics/mta-cli/ref_supported-migration-paths.adoc @@ -166,7 +166,9 @@ pass:[] [IMPORTANT] ==== [subs="attributes+"] -{FeatureName} is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA. +{FeatureName} is Developer Preview software only. Developer Preview software is not supported by Red{nbsp}Hat in any way and is not functionally complete or production-ready. Do not use Developer Preview software for production or business-critical workloads. Developer Preview software provides early access to upcoming product software in advance of its possible inclusion in a Red{nbsp}Hat product offering. Customers can use this software to test functionality and provide feedback during the development process. This software might not have any documentation, is subject to change or removal at any time, and has received limited testing. Red{nbsp}Hat might provide ways to submit feedback on Developer Preview software without an associated SLA. + +For more information about the support scope of Red{nbsp}Hat Developer Preview software, see link:https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope]. ==== :!FeatureName: diff --git a/docs/topics/mta-ui/con_assessment-module-features.adoc b/docs/topics/mta-ui/con_assessment-module-features.adoc index 9bdef920..4738d8ce 100644 --- a/docs/topics/mta-ui/con_assessment-module-features.adoc +++ b/docs/topics/mta-ui/con_assessment-module-features.adoc @@ -6,15 +6,18 @@ = The Assessment module features [role="_abstract"] -The assessment module in the {ProductFullName} user interface (UI) uses customizable questionnaires to evaluate the suitability of applications for modernization. Understanding these features allows you to identify migration risks, estimate effort, and prioritize applications within your portfolio. +You can use the assessment module in the {ProductFullName} user interface (UI) to evaluate the suitability of applications for modernization. These evaluations help you identify migration risks, estimate modernization effort, and prioritize applications in your portfolio. The {ProductFullName} *Assessment* module offers the following features for assessing and analyzing applications: Assessment hub:: The *Assessment* hub integrates with the *Application inventory*. +Assessment questionnaires:: +The *Assessment* module supports assessment questionnaires relevant to one or more applications. + Enhanced assessment questionnaire capabilities:: -In {ProductShortName} 7.0, you can import and export assessment questionnaires. You can also design custom questionnaires with a downloadable template by using the YAML syntax, which includes the following features: +You can import and export assessment questionnaires. You can also design custom questionnaires with a downloadable template by using the YAML syntax, which includes the following features: * Conditional questions: You can include or exclude questions based on the application or archetype if a certain tag is present on this application or archetype. * Application auto-tagging based on answers: You can define tags to be applied to applications or archetypes if a certain answer was provided. @@ -23,11 +26,8 @@ In {ProductShortName} 7.0, you can import and export assessment questionnaires. + NOTE: You can customize and save the default questionnaire. -Multiple assessment questionnaires:: -The *Assessment* module supports multiple questionnaires, relevant to one or more applications. - Archetypes:: -You can group applications with similar characteristics into archetypes. This allows you to assess multiple applications at once. Each archetype has a shared taxonomy of tags, stakeholders, and stakeholder groups. All applications inherit assessment and review from their assigned archetypes. +You can use archetypes to assess a group applications with similar characteristics. Each archetype has a shared taxonomy of tags, stakeholders, and stakeholder groups. All applications inherit assessment and review from their assigned archetypes. [role="_additional-resources"] diff --git a/docs/topics/mta-ui/con_mta-default-questionnaire.adoc b/docs/topics/mta-ui/con_mta-default-questionnaire.adoc index 6867b009..57007414 100644 --- a/docs/topics/mta-ui/con_mta-default-questionnaire.adoc +++ b/docs/topics/mta-ui/con_mta-default-questionnaire.adoc @@ -8,9 +8,9 @@ = The default assessment questionnaire [role="_abstract"] -_Legacy Pathfinder_ is the default {ProductFullName} questionnaire. Pathfinder is a questionnaire-based tool that you can use to evaluate the suitability of applications for modernization in containers on an enterprise Kubernetes platform.  +_Legacy Pathfinder_ is the default {ProductFullName} questionnaire. Pathfinder is a questionnaire-based tool that you can use to evaluate the suitability of applications for modernization in containers on an enterprise Kubernetes platform. -Through interaction with the default questionnaire and the review process, the system is enriched with application knowledge exposed through the collection of assessment reports. +By completing the default questionnaire and review process, you enrich the system with application knowledge that assessment reports include. You can export the default questionnaire to a YAML file: @@ -568,7 +568,7 @@ sections: rationale: '' mitigation: '' - order: 2 - text: TCP/IP, with host name or IP address encapsulated in the payload + text: TCP/IP, with hostname or IP address encapsulated in the payload risk: red rationale: '' mitigation: '' @@ -964,7 +964,7 @@ sections: - order: 2 text: >- Configuration files are stored externally (example: in a database) - and accessed using specific environment keys (examples: host name, + and accessed using specific environment keys (examples: hostname, IP address) risk: red rationale: '' @@ -1060,7 +1060,7 @@ sections: rationale: '' mitigation: '' - order: 3 - text: 'Private cloud (example: red Hat OpenStack Platform)' + text: 'Private cloud (example: Red Hat OpenStack Platform)' risk: green rationale: '' mitigation: '' diff --git a/docs/topics/mta-ui/proc_adding-applications.adoc b/docs/topics/mta-ui/proc_adding-applications.adoc index db82656f..89cb3aa9 100644 --- a/docs/topics/mta-ui/proc_adding-applications.adoc +++ b/docs/topics/mta-ui/proc_adding-applications.adoc @@ -11,7 +11,7 @@ To populate your inventory for analysis, add applications to the {ProductFullNam You can add a new application to the *Application Inventory* for subsequent assessment and analysis. -NOTE: Before creating an application, set up business services, check tags and tag categories, and create additions as needed. +NOTE: Before creating an application, set up business services, check tags and tag categories, and create additions. .Prerequisites @@ -33,19 +33,21 @@ NOTE: Before creating an application, set up business services, check tags and t . Click *Source Code* and enter the following fields: * *Repository type*: *Git* or *Subversion*. * *Source repository*: A URL of the repository where the software code is saved. -** For Subversion: this must be either the URL to the root of the repository or a fully qualified URL which (optionally) includes the branch and nested directory. When fully qualified, the *Branch* and *Root path* must be blank. ++ +For the *Subversion* repository type, the URL to the root of the repository or a fully qualified URL which optionally includes the branch and nested directory. When fully qualified, the *Branch* and *Root path* must be blank. + * *Branch*: An application code branch in the repository (optional). -** For Git: this may be any reference; `commit-hash`, `branch` or `tag`. -** For Subversion: this may be a fully qualified path to a branch or tag, for example, `branches/stable` or `tags/stable`. This must be blank when the Source repository URL includes the branch. +** For the *Git* repository type, this branch can be any reference, for example, `commit-hash`, `branch`, or `tag`. +** For the *Subversion* repository type, this branch is a fully qualified path to an application's branch or tag, for example, `branches/stable` or `tags/stable`. This must be blank when the *Source repository* URL includes the branch. * *Root path*: A root path inside the repository for the target application (optional). -** For Subversion: this must be blank when the Source Repository URL includes the root path. ++ +For the *Subversion* repository type, this field must be blank when the *Source repository* URL includes the root path. + -NOTE: If you enter any value in either the Branch or Root path fields, the Source repository field becomes mandatory. +NOTE: If you enter any value in either the *Branch* or *Root path* fields, the *Source repository* field becomes mandatory. . Optional: Click *Binary* and enter the following fields: -// ![](/Tackle2/AddingApps/NewAppBinary.png) * *Group*: The Maven group for the application artifact. * *Artifact*: The Maven artifact for the application. * *Version*: A software version of the application. @@ -54,7 +56,7 @@ NOTE: If you enter any value in either the Branch or Root path fields, the Sourc + NOTE: If you enter any value in any of the Binary section fields, all fields automatically become mandatory. -. Click *Create*. The new application appears in the list of defined applications. +. Click *Create*. The new application is displayed in the list of defined applications. . Optional: Change the application settings by clicking *Edit* next to the application name: diff --git a/docs/topics/mta-ui/proc_adding-source-platform-application.adoc b/docs/topics/mta-ui/proc_adding-source-platform-application.adoc index 6e445afa..06ad565e 100644 --- a/docs/topics/mta-ui/proc_adding-source-platform-application.adoc +++ b/docs/topics/mta-ui/proc_adding-source-platform-application.adoc @@ -17,7 +17,7 @@ The specific coordinates vary depending on the source platform you select. For e .Procedure . In the {ProductShortName} user interface, select the *Migration* mode. -. On the *Application Inventory* page, click the edit icon (image:icon_edit.png[]) in an application. The *Update application* dialog appears. +. On the *Application Inventory* page, click the edit icon (image:icon_edit.png[edit icon]) in an application. . Enter the following information in the form: .. Click *Source platform* and enter the following fields: ... *Source platform*: Select a source platform instance. diff --git a/docs/topics/mta-ui/proc_assessing-an-application.adoc b/docs/topics/mta-ui/proc_assessing-an-application.adoc index 034a79b6..c8f1d5a7 100644 --- a/docs/topics/mta-ui/proc_assessing-an-application.adoc +++ b/docs/topics/mta-ui/proc_assessing-an-application.adoc @@ -30,7 +30,7 @@ During the assessment, you might encounter false positives in an application tha .Procedure . In the {ProductShortName} user interface, select the *Migration* view. -. Click *Application inventory* in the left menu bar. A list of the available applications appears in the main pane. +. Click *Application inventory* in the left menu bar. . Select the application you want to assess. . Click the *Options* menu ({kebab}) at the right end of the row and select *Assess* from the drop-down menu. . From the list of available questionnaires, click *Take* for the desired questionnaire. diff --git a/docs/topics/mta-ui/proc_assessing-an-archetype.adoc b/docs/topics/mta-ui/proc_assessing-an-archetype.adoc index 5646c094..1f9c5d46 100644 --- a/docs/topics/mta-ui/proc_assessing-an-archetype.adoc +++ b/docs/topics/mta-ui/proc_assessing-an-archetype.adoc @@ -8,9 +8,9 @@ [role="_abstract"] To estimate the modernization effort for groups of applications with similar characteristics, assess an archetype in the {ProductFullName} user interface (UI). -The archetype is considered assessed when all required questionnaires have been answered. +The {ProductShortName} marks an archetype as assessed after you answer all required questionnaires. -NOTE: If an application is associated with several archetypes, this application is considered assessed when all associated archetypes have been assessed. +NOTE: If you associate an application with several archetypes, the {ProductShortName} marks the application as assessed only after you assess all of its associated archetypes. .Prerequisites diff --git a/docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc b/docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc index a2f466cf..9ae20226 100644 --- a/docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc +++ b/docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc @@ -11,14 +11,14 @@ To determine which specific lines of code you must modify before migrating or mo You can analyze more than one application at a time against more than one transformation target in the same analysis. -IMPORTANT: If you analyze an application that requires Maven credentials to access private repositories, you must assign these credentials in the Credentials section of the Administration view. Otherwise, there might be an impact on the quality of the analysis, identified issues, or the {ProductShortName} performance. For more information, see xref:configuring-credentials_configuring-mta-instance-environment[Configuring credentials]. +IMPORTANT: If you analyze an application that requires Maven credentials to access private repositories, you must assign these credentials in the *Credentials* section of the *Administration* view. Otherwise, there might be an impact on the quality of the analysis, identified issues, or the {ProductShortName} performance. For more information, see xref:configuring-credentials_configuring-mta-instance-environment[Configuring credentials]. [IMPORTANT] ==== -When your system is in a disconnected environment, but you have access to a Maven proxy, the application analysis runs without failure. However, if you do not have access to the Maven proxy, Maven cannot build the application because it cannot access the required dependencies. +When your system is in a disconnected environment, but you have access to a Maven proxy, the application analysis runs without failure. However, if you do not have access to the Maven proxy, Maven is unable to build the application because it cannot access the required dependencies. -Note also that the analysis output in the disconnected environment usually results in fewer incidents because a dependency analysis does not run accurately without access to Maven. +Note that the analysis output in the disconnected environment usually results in fewer incidents because a dependency analysis does not run accurately without access to Maven. ==== NOTE: After creating an application instance on the *Application Inventory* page, the language discovery task starts, automatically preselecting the target filter option. However, you can choose a different preferred language. @@ -28,19 +28,13 @@ NOTE: After creating an application instance on the *Application Inventory* page . In the *Migration* view, click *Application inventory*. . Select an application that you want to analyze. -+ -// ![](/Tackle2/AppAssessAnalyze/SelectManageCred.png) - . Review the credentials assigned to the application. . Click *Analyze*. -+ -// ![](/Tackle2/AppAssessAnalyze/AnalysisMode.png) - . Select the *Analysis mode* from the list: -* Binary -* Source code -* Source code and dependencies -* Upload a local binary. This option only appears if you are analyzing a single application. If you chose this option, you are prompted to *Upload a local binary*. Either drag a file into the area provided or click *Upload* and select the file to upload. +* *Binary* +* *Source code* +* *Source code and dependencies* +* *Upload a local binary*. This option is available if you are analyzing a single application. If you choose this option, drag a file into the *Upload a local binary* area, or click *Upload* to select a file. . Click *Next*. . Select one or more target options for the analysis: @@ -50,7 +44,7 @@ NOTE: After creating an application instance on the *Application Inventory* page * Containerization * Quarkus * OracleJDK to OpenJDK -* OpenJDK. Use this option to upgrade to either of the following JDK versions: +* Open Java Development Kit (OpenJDK). Use this option to upgrade to either of the following JDK versions: ** OpenJDK 11 ** OpenJDK 17 ** OpenJDK 21 @@ -65,35 +59,35 @@ NOTE: After creating an application instance on the *Application Inventory* page * Application and internal dependencies only. * Application and all dependencies, including known Open Source libraries. -* Select the list of packages to be analyzed manually. If you choose this option, type the file name and click *Add*. -* Exclude packages. If you choose this option, type the name of the package and click *Add*. +* Select the list of packages for the manual analysis. If you choose this option, type the file name and click *Add*. +* Exclude packages. If you choose this option, type the package name and click *Add*. . Click *Next*. -. In *Advanced*, you can attach additional custom rules to the analysis by selecting the *Manual* or *Repository* mode: -** In the *Manual* mode, click *Add Rules*. Drag the relevant files or select the files from their directory and click *Add*. -** In the *Repository* mode, you can add rule files from a Git or Subversion repository. +. In *Advanced*, attach additional custom rules to the analysis by selecting *Manual* or *Repository* mode: +** In *Manual* mode, click *Add Rules*. Drag the relevant files or select the files from their directory and click *Add*. +** In *Repository* mode, add rule files from a *Git* or *Subversion* repository. + IMPORTANT: Attaching custom rules is optional if you have already attached a migration target to the analysis. If you have not attached any migration target, you must attach rules. . Optional: Set any of the following options: * Target * Source(s) -* Excluded rules tags. Rules with these tags are not processed. Add or delete as needed. +* Excluded rules tags. Rules with these tags are not processed. Add or delete as required. * Enable automated tagging. Select the checkbox to automatically attach tags to the application. This checkbox is selected by default. + -NOTE: Automatically attached tags are displayed only _after_ you run the analysis. You can attach tags to the application manually instead of enabling automated tagging or in addition to it. +NOTE: The {ProductShortName} displays automatically attached tags only after you run the analysis. You can attach tags to the application manually instead of enabling automated tagging or in addition to it. + -NOTE: Analysis engines use standard rules for a comprehensive set of migration targets. However, if the target is not included, is a customized framework, or the application is written in a language that is not supported, for example, Ruby, you can add custom rules by skipping the target selection in the Set Target tab and uploading custom rule files in the Custom Rules tab. Only custom rule files that are uploaded manually are validated. +NOTE: Analysis engines use standard rules for a comprehensive set of migration targets. If your target is missing, uses a customized framework, or uses an unsupported language such as Ruby, you can add custom rules. To add custom rules, skip the target selection on the *Set Target* tab and upload custom rule files on the *Custom Rules* tab. The {ProductShortName} validates only the custom rule files that you manually upload. . Click *Next*. . In *Review*, verify the analysis parameters. . Click *Run*. + -The analysis status is `Scheduled` as {ProductShortName} downloads the image for the container to execute. When the image is downloaded, the status changes to `In-progress.` +The analysis status is `Scheduled` while the {ProductShortName} downloads the container image. After the download completes, the status changes to `In-progress`. + -NOTE: Analysis takes minutes to hours to run depending on the size of the application and the capacity and resources of the cluster. +Analysis takes minutes to hours to run depending on the size of the application and the capacity and resources of the cluster. + -NOTE: {ProductShortName} relies on Kubernetes scheduling capabilities to determine how many analyzer instances are created based on cluster capacity. If several applications are selected for analysis, by default, only one analyzer can be provisioned at a time. With more cluster capacity, more analysis processes can be executed in parallel. +NOTE: The {ProductShortName} uses Kubernetes scheduling capabilities to determine how many analyzer instances to create based on cluster capacity. By default, if you select multiple applications for analysis, the {ProductShortName} provisions only one analyzer at a time. With additional cluster capacity, the {ProductShortName} can execute more analysis processes in parallel. . Optional: To track the status of your active analysis task, open the *Task Manager* drawer by clicking the notifications button. + diff --git a/docs/topics/mta-ui/proc_configuring-asset-repository.adoc b/docs/topics/mta-ui/proc_configuring-asset-repository.adoc index 86a43e9f..4e253cfd 100644 --- a/docs/topics/mta-ui/proc_configuring-asset-repository.adoc +++ b/docs/topics/mta-ui/proc_configuring-asset-repository.adoc @@ -13,7 +13,7 @@ When you configure the asset repository for an application, you can also associa .Procedure . In the *Migration* view, click *Applications*. -. Click the edit icon (image:icon_edit.png[]) to update an imported application. +. Click the edit icon (image:icon_edit.png[edit icon]) to update an imported application. . In the *Update application* dialog, click *Asset repository* and configure the following details: .. Select the *Asset repository type* from *Git* or *Subversion*. .. Enter the asset repository URL in the *Asset repository* field. diff --git a/docs/topics/mta-ui/proc_configuring-git-repos.adoc b/docs/topics/mta-ui/proc_configuring-git-repos.adoc index a249aa33..1381aae6 100644 --- a/docs/topics/mta-ui/proc_configuring-git-repos.adoc +++ b/docs/topics/mta-ui/proc_configuring-git-repos.adoc @@ -7,10 +7,9 @@ = Configuring Git repositories [role="_abstract"] -To allow {ProductFullName} to access the data required for migration tasks, configure Git repositories in the user interface (UI). By configuring these repositories, you enable {ProductShortName} to access your source code to identify modernization paths and required steps for your modernization efforts. +To allow {ProductFullName} to access the data required for migration tasks, configure *Git* repositories in the user interface (UI). By configuring these repositories, you enable {ProductShortName} to access your source code to identify modernization paths and required steps for your modernization efforts. .Procedure . In *Administration* view, click *Repositories* and then click *Git*. -// ![](/Tackle2/Views/GitConfig.png) . Enable the *Consume insecure Git repositories* switch. diff --git a/docs/topics/mta-ui/proc_configuring-jira-credentials.adoc b/docs/topics/mta-ui/proc_configuring-jira-credentials.adoc index 2355f9b5..397141ae 100644 --- a/docs/topics/mta-ui/proc_configuring-jira-credentials.adoc +++ b/docs/topics/mta-ui/proc_configuring-jira-credentials.adoc @@ -34,14 +34,14 @@ NOTE: To obtain a Jira token, you need to log in to the Jira site. .. Click *Save*. + -The new credential appears on the *Credentials* page. +The new credential is displayed on the *Credentials* page. * If you selected *Bearer Token (Jira)*, complete the following steps: .. In the *Token* field, enter your token generated on the Jira site. .. Click *Save*. + -The new credential appears on the *Credentials* page. +The new credential is displayed on the *Credentials* page. . Optional: To edit the credential, click *Edit*. diff --git a/docs/topics/mta-ui/proc_configuring-maven-repo.adoc b/docs/topics/mta-ui/proc_configuring-maven-repo.adoc index cc397246..3515d463 100644 --- a/docs/topics/mta-ui/proc_configuring-maven-repo.adoc +++ b/docs/topics/mta-ui/proc_configuring-maven-repo.adoc @@ -7,9 +7,9 @@ = Configuring a Maven repository [role="_abstract"] -To give {ProductFullName} access to the data required for the migration tasks, configure Maven repositories in the user interface (UI). By configuring these repositories, you allow {ProductShortName} to access your source code to identify modernization paths and required steps for your modernization efforts. +To give {ProductFullName} access to the data required for the migration tasks, configure *Maven* repositories in the user interface (UI). By configuring these repositories, you allow {ProductShortName} to access your source code to identify modernization paths and required steps for your modernization efforts. -You can both configure a Maven repository and reduce its size in the *Repositories* view of the {ProductShortName} UI. +You can both configure a *Maven* repository and reduce its size in the *Repositories* view of the {ProductShortName} UI. IMPORTANT: If the `rwx_supported` configuration option of the Tackle CR is set to `false`, both the *Local artifact repository* field and the *Clear repository* button are disabled. Therefore, you cannot perform the following procedure. @@ -17,6 +17,6 @@ IMPORTANT: If the `rwx_supported` configuration option of the Tackle CR is set t . In *Administration* view, click *Repositories* and then click *Maven*. . Enable the *Consume insecure artifact repositories* switch. -. Optional: To reduce the size of the Maven repository, click the *Clear repository* link. +. Optional: To reduce the size of the *Maven* repository, click the *Clear repository* link. + -NOTE: Depending on the size of the Maven repository, the size change might not be evident. +NOTE: Depending on the size of the *Maven* repository, the size change might not be evident. \ No newline at end of file diff --git a/docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc b/docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc index 3d43a697..e2209942 100644 --- a/docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc +++ b/docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc @@ -8,7 +8,7 @@ [role="_abstract"] -As an Architect, you can configure a profile that has the configuration needed to analyze an application for a specific migration target. +As an Architect, you can configure a profile that has the configuration required to analyze an application for a specific migration target. .Procedure @@ -59,7 +59,7 @@ IMPORTANT: Attaching custom rules is optional if you have already attached a mig . Optional: Set any of the following options: * Additional target labels * Additional source labels -* Excluded rules labels. Rules with these labels are not processed. Add or delete as needed. +* Excluded rules labels. Rules with these labels are not processed. Add or delete as required. . Click *Next*. . In *Review*, verify the analysis parameters. diff --git a/docs/topics/mta-ui/proc_configuring-subversion-repos.adoc b/docs/topics/mta-ui/proc_configuring-subversion-repos.adoc index 8b234d88..d30ea315 100644 --- a/docs/topics/mta-ui/proc_configuring-subversion-repos.adoc +++ b/docs/topics/mta-ui/proc_configuring-subversion-repos.adoc @@ -7,10 +7,9 @@ = Configuring Subversion repositories [role="_abstract"] -To allow the {ProductFullName} to access the data required for the migration tasks, configure Subversion repositories in the user interface (UI). By configuring these repositories, you allow {ProductShortName} to access your source code to identify modernization paths and required steps for your modernization efforts. +To allow the {ProductFullName} to access the data required for the migration tasks, configure *Subversion* repositories in the user interface (UI). By configuring these repositories, you allow {ProductShortName} to access your source code to identify modernization paths and required steps for your modernization efforts. .Procedure . In *Administration* view, click *Repositories* and then click *Subversion*. -// ![](/Tackle2/Views/SubsConfig.png) . Enable the *Consume insecure Subversion repositories* switch. diff --git a/docs/topics/mta-ui/proc_configuring-target-profiles.adoc b/docs/topics/mta-ui/proc_configuring-target-profiles.adoc index 733d79d7..b3d4b403 100644 --- a/docs/topics/mta-ui/proc_configuring-target-profiles.adoc +++ b/docs/topics/mta-ui/proc_configuring-target-profiles.adoc @@ -19,11 +19,11 @@ The generators are run in a priority order, in which manifests generated by lowe . In the *Migration* view, click *Archetypes*. . Click the Options menu ({kebab}) of an archetype, and select *Manage target profiles*. + -The *Target profiles for * appears. +The *Target profiles for __* is displayed. . Click *Create new target profile*. . In the *Name* field in the opened dialogue, enter a unique name for the target profile. . Click the *Tag category* field and select the category tag to associate with the tag. . Select specific generators and click the right arrow to move the generator from the *Available generators* list to the *Chosen generators* list. . (Optional) Select an analysis profile for the application from the list. You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list. . Click *Create*. -. You can click on the archetype row to open the archetype detail view where the target profiles for the archetype are listed. +. You can click the archetype row to open the archetype detail view where the target profiles for the archetype are listed. diff --git a/docs/topics/mta-ui/proc_creating-a-business-service.adoc b/docs/topics/mta-ui/proc_creating-a-business-service.adoc index 6e589896..0d97f592 100644 --- a/docs/topics/mta-ui/proc_creating-a-business-service.adoc +++ b/docs/topics/mta-ui/proc_creating-a-business-service.adoc @@ -10,11 +10,11 @@ To organize your application portfolio by function, create business services in .Procedure -. In the *Migration* view, click *Controls*. -. Click *Business services*. -. Click *Create new*. -. Enter the following information: -* Name -* Description -* Owner -. Click *Create*. +. In the *Migration* view, click *Controls*. +. Click *Business services*. +. Click *Create new*. +. Enter the following information: +* Name +* Description +* Owner +. Click *Create*. diff --git a/docs/topics/mta-ui/proc_creating-a-jira-connection.adoc b/docs/topics/mta-ui/proc_creating-a-jira-connection.adoc index c08737cc..941c359b 100644 --- a/docs/topics/mta-ui/proc_creating-a-jira-connection.adoc +++ b/docs/topics/mta-ui/proc_creating-a-jira-connection.adoc @@ -9,7 +9,7 @@ [role="_abstract"] To track your application migrations, define a Jira instance in the {ProductFullName} user interface and establish a connection to that instance. -Note that you cannot remove a Jira connection that you used for creating issues for a migration wave if the issues exist in Jira, even after the migration wave is deleted. +You cannot remove a Jira connection used to create issues for a migration wave if those issues still exist in Jira, even after you delete the migration wave. .Prerequisites @@ -17,31 +17,21 @@ Note that you cannot remove a Jira connection that you used for creating issues .Procedure -. In *Administration* view, under *Issue Management*, click *Jira*. +. In the *Administration* view, under *Issue Management*, click *Jira*. . Click *Create new*. . In the *New instance* window, enter the following information: * Name of the instance * URL of the web interface of your Jira account -* Select either the *Jira Cloud* or *Jira Server/Data center* instance type from the list -* Select credentials from the list -+ -[NOTE] -==== -If you selected *Jira Cloud* as an instance type, only *Basic Auth* credentials are displayed in the list. - -If you selected *Jira Server/Data center* as an instance type, both *Basic Auth* and *Token Bearer* credentials are displayed. - -Choose the type that is appropriate for the particular configuration of your Jira server or data center. -==== -+ -. By default, a connection cannot be established with a server with an invalid certificate. To override this restriction, enable the *Enable insecure communication* switch. +* Select either the *Jira Cloud* or *Jira Server/Data center* instance type. +* Select credentials from the list: +** If you selected *Jira Cloud* as the instance type, the list displays only *Basic Auth* credentials. +** If you selected *Jira Server/Data center* as an instance type, the list displays both *Basic Auth* and *Token Bearer* credentials. +. By default, you cannot establish a connection with a server that has an invalid certificate. To override this restriction, enable the *Enable insecure communication* switch. . Click *Create*. -+ -The new connection instance appears on the *Jira configuration* page. .Verification -* On the *Jira configuration* page, ensure that the connection has been established and authorized: +* On the *Jira configuration* page, ensure that you established and authorized the connection: -** If the status of the *Connection* column displays *Connected*, the Jira connection is established and authorized. -** If the status of the *Connection* column displays *Not connected*, click the status to check the reason for the error. \ No newline at end of file +** If the *Connection* column displays *Connected*, you have successfully established and authorized the Jira connection. +** If the *Connection* column displays *Not connected*, click the status to check the reason for the error. \ No newline at end of file diff --git a/docs/topics/mta-ui/proc_creating-a-stakeholder.adoc b/docs/topics/mta-ui/proc_creating-a-stakeholder.adoc index 97304430..80e09c09 100644 --- a/docs/topics/mta-ui/proc_creating-a-stakeholder.adoc +++ b/docs/topics/mta-ui/proc_creating-a-stakeholder.adoc @@ -8,39 +8,39 @@ [role="_abstract"] To identify the individuals responsible for specific applications, define stakeholders in the {ProductFullName} user interface (UI). Defining these roles ensures that migration assessments and questionnaires are directed to the correct subject matter experts for each application. -You can create and configure stakeholders in any order. However, the following is the most efficient order: +You can create and configure stakeholders in any order. However, the following is the most efficient order: -. Create Stakeholder groups. Note that by default, no stakeholder groups are defined. -. Create Job functions. The job function attribute classifies stakeholders and provides a list of default values that can be expanded. -. Create Stakeholders. +. Create stakeholder groups. Note that by default, no stakeholder groups are defined. +. Create job functions. The job function attribute classifies stakeholders and provides a list of default values that can be expanded. +. Create stakeholders. .Procedure . Create a stakeholder group: -.. In the *Migration* view, click *Controls*. -.. Click *Stakeholder groups*. -.. Click *Create new*. -.. Enter the following information: -* Name -* Description -* Member(s) +.. In the *Migration* view, click *Controls*. +.. Click *Stakeholder groups*. +.. Click *Create new*. +.. Enter the following information: +* Name +* Description +* Member(s) .. Click *Create*. . Create a new job function: -.. In the *Migration* view, click *Controls*. -.. Click *Job functions*. -.. Click *Create new*. -.. In the *Name* text box, enter a job function title. -.. Click *Create*. +.. In the *Migration* view, click *Controls*. +.. Click *Job functions*. +.. Click *Create new*. +.. In the *Name* text box, enter a job function title. +.. Click *Create*. . Create a new stakeholder: -.. In the *Migration* view, click *Controls*. -.. Click *Stakeholders*. -.. Click *Create new*. -.. Enter the following information: -* Email -* Name -* Job function. Note that you can create custom functions . -* Stakeholder group -.. Click *Create*. \ No newline at end of file +.. In the *Migration* view, click *Controls*. +.. Click *Stakeholders*. +.. Click *Create new*. +.. Enter the following information: +* Email +* Name +* Job function. Note that you can create custom functions. +* Stakeholder group +.. Click *Create*. \ No newline at end of file diff --git a/docs/topics/mta-ui/proc_creating-a-tag.adoc b/docs/topics/mta-ui/proc_creating-a-tag.adoc index c4bfec23..f7359dbc 100644 --- a/docs/topics/mta-ui/proc_creating-a-tag.adoc +++ b/docs/topics/mta-ui/proc_creating-a-tag.adoc @@ -8,7 +8,7 @@ [role="_abstract"] To categorize applications based on certain parameters, create tags in the {ProductFullName} user interface (UI). -{ProductFirstRef} uses tags in multiple categories and provides a list of default values. However, you can create your own tag category and a new tag that is not in the default list. +{ProductFirstRef} uses tags in different categories and provides a list of default values. However, you can create your own tag category and a new tag that is not in the default list. You can create and configure tags in any order. However, the following is the most efficient order: @@ -18,20 +18,20 @@ You can create and configure tags in any order. However, the following is the mo .Procedure . Create a tag category: -.. In the *Migration* view, click *Controls*. -.. Click *Tags*. -.. Click *Create tag category*. -.. Enter the following information: -* Name -* Rank: The order in which the tags appear on the applications. -* Color -.. Click *Create*. +.. In the *Migration* view, click *Controls*. +.. Click *Tags*. +.. Click *Create tag category*. +.. Enter the following information: +* Name +* Rank: The order in which the tags appear on the applications. +* Color +.. Click *Create*. . Create a tag: -.. In the *Migration* view, click *Controls*. -.. Click *Tags*. -.. Click *Create tag*. -.. Enter the following information: -* Name -* Tag category -.. Click *Create*. \ No newline at end of file +.. In the *Migration* view, click *Controls*. +.. Click *Tags*. +.. Click *Create tag*. +.. Enter the following information: +* Name +* Tag category +.. Click *Create*. \ No newline at end of file diff --git a/docs/topics/mta-ui/proc_creating-application-tags.adoc b/docs/topics/mta-ui/proc_creating-application-tags.adoc index a0fa1e8b..b756b58d 100644 --- a/docs/topics/mta-ui/proc_creating-application-tags.adoc +++ b/docs/topics/mta-ui/proc_creating-application-tags.adoc @@ -24,8 +24,8 @@ To categorize applications according to your needs, create custom tags in the {P ... Click *Save*. ** Edit the tag category: ... Under the *Tags* tab, select a defined tag category and click *Edit*. -... Edit the tag category’s name in the *Name* field. -... Edit the category’s *Rank* value. +... Edit the tag category's name in the *Name* field. +... Edit the category's *Rank* value. ... Click the *Color* field and select a color for the tag category. ... Click *Save*. diff --git a/docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc b/docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc index f029e578..1eb3027d 100644 --- a/docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc +++ b/docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc @@ -9,13 +9,13 @@ [role="_abstract"] To track modernization progress for a group of applications bundled under a migration wave, create a Jira issue in the {ProductFullName} user interface (UI). -You can use a migration wave to create Jira issues automatically for each application assigned to the migration wave. A separate Jira issue is created for each application associated with the migration wave. The following fields of each issue are filled in automatically: +You can use a migration wave to automatically create a separate Jira issue for each assigned application. The {ProductShortName} automatically populates the following fields for each issue: -* Title: `Migrate ` +* Title: `Migrate __` * Reporter: Username of the token owner. * Description: `Created by Konveyor` -NOTE: You cannot delete an application if it is linked to a Jira ticket or is associated with a migration wave. To unlink the application from the Jira ticket, click the `Unlink from Jira` icon in the details view of the application or in the details view of a migration wave. +NOTE: You cannot delete an application that has a linked Jira ticket or belongs to a migration wave. To unlink the application from the Jira ticket, click the *Unlink from Jira* icon in the application or migration wave details view. .Prerequisites @@ -26,15 +26,8 @@ NOTE: You cannot delete an application if it is linked to a Jira ticket or is as . In the *Migration* view, click *Migration waves*. . Click the Options menu ({kebab}) to the right of the migration wave for which you want to create Jira issues and select *Export to Issue Manager*. The *Export to Issue Manager* window opens. -. Select the Jira Cloud or Jira Server/Datacenter instance type. +. Select the *Jira Cloud* or *Jira Server/Data center* instance type. . Select the instance, project, and issue type from the lists. . Click *Export*. The status of the migration wave on the *Migration waves* page changes to `Issues Created`. . Optional: To see the status of each individual application of a migration wave, click the *Status* column. -. Optional: To see if any particular application is associated with a migration wave, open the application's *Details* tab on the *Application inventory* page. - -//// -[NOTE] -==== -After you exported a migration wave to the Issue Manager and the Jira issues are created, you can no longer change them from within the {ProductShortName} {WebName}. Even if you delete the migration wave, the Jira issues remain. -==== -//// +. Optional: To display an application associated with a migration wave, open the application's *Details* tab on the *Application inventory* page. \ No newline at end of file diff --git a/docs/topics/mta-ui/proc_creating-migration-waves.adoc b/docs/topics/mta-ui/proc_creating-migration-waves.adoc index 37148bba..d7346647 100644 --- a/docs/topics/mta-ui/proc_creating-migration-waves.adoc +++ b/docs/topics/mta-ui/proc_creating-migration-waves.adoc @@ -21,7 +21,7 @@ A migration wave is a group of applications that you can migrate on a given sche * *Potential end date*. This date must be later than the start date. * *Stakeholders* (optional) * *Stakeholder groups* (optional) -. Click *Create*. The new migration wave appears in the list of existing migration waves. +. Click *Create*. The new migration wave is displayed in the list of existing migration waves. . To assign applications to the migration wave, click the Options menu ({kebab}) to the right of the migration wave and select *Manage applications*. + The *Manage applications* window opens that displays the list of applications that are not assigned to any other migration wave. diff --git a/docs/topics/mta-ui/proc_creating-source-platform.adoc b/docs/topics/mta-ui/proc_creating-source-platform.adoc index 3b502f3d..832bdf40 100644 --- a/docs/topics/mta-ui/proc_creating-source-platform.adoc +++ b/docs/topics/mta-ui/proc_creating-source-platform.adoc @@ -17,7 +17,7 @@ An {ProductShortName} administrator can configure one or more source platform in . In the {ProductShortName} user interface, select the *Administration* working mode. . Click *Source platform* in the left menu bar to go to the *Source platforms* page. -. Click *Create new platform*. The *Create new platform* dialog appears. +. Click *Create new platform*. . In the form, enter the following information: .. *Name*: A unique name for the source platform (CF) instance. .. *Type*: Select source platform from the drop down menu. For example, *Cloud Foundry*. diff --git a/docs/topics/mta-ui/proc_defining-an-archetype.adoc b/docs/topics/mta-ui/proc_defining-an-archetype.adoc index 66a64352..72c15a77 100644 --- a/docs/topics/mta-ui/proc_defining-an-archetype.adoc +++ b/docs/topics/mta-ui/proc_defining-an-archetype.adoc @@ -6,7 +6,7 @@ = Creating an archetype [role="_abstract"] -To assess multiple applications with shared characteristics simultaneously, define an archetype in the {ProductFullName} user interface (UI). +To assess a group of applications with shared characteristics, define an archetype in the {ProductFullName} user interface (UI). When you create the archetype, an application in the inventory is automatically associated with that archetype if this application has the tags that match the criteria tags of the archetype. diff --git a/docs/topics/mta-ui/proc_displaying-automated-tasks.adoc b/docs/topics/mta-ui/proc_displaying-automated-tasks.adoc index a3d3a3ec..e19e9ffb 100644 --- a/docs/topics/mta-ui/proc_displaying-automated-tasks.adoc +++ b/docs/topics/mta-ui/proc_displaying-automated-tasks.adoc @@ -13,13 +13,13 @@ After you add a new application to the *Application Inventory*, you can display * The language discovery task identifies the programming languages in the application. * The technology discovery task identifies specific technologies in the application. -These tasks automatically add appropriate tags to the application, reducing the effort involved in manually assigning tags to the application. After these tasks are complete, the number of tags added to the application appears under the *Tags* column. +These tasks automatically add appropriate tags to the application, reducing the effort involved in manually assigning tags to the application. After these tasks are complete, the number of tags added to the application is displayed under the *Tags* column. -NOTE: You can add additional tags manually as needed. When MTA analyzes the application, it can add additional tags to the application automatically. +NOTE: You can add additional tags manually. When MTA analyzes the application, it can add additional tags to the application automatically. .Procedure . In the *Application Inventory*, hover over the application name to display the automated tasks. . Display the application tags: -.. Click on the application’s row entry. A side pane opens. +.. Click the application's row entry. A side pane opens. .. Click the *Tags* tab. The tags attached to the application are displayed. diff --git a/docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc b/docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc index c8c9cd9f..1b03d47c 100644 --- a/docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc +++ b/docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc @@ -20,7 +20,7 @@ For your convenience, you can download analysis reports. Note that by default th . In *Administration* view, click *General*. . Toggle the *Allow reports to be downloaded after running an analysis.* switch. . Go to the *Migration* view and click *Application inventory*. -. Click on the application row to open the application drawer. +. Click the application row to open the application drawer. . Click the *Reports* tab. . Click either the *HTML* or *YAML* link: * By clicking the *HTML* link, you download the compressed `analysis-report-app-.tar` file. Extracting this file creates a folder with the same name as the application. diff --git a/docs/topics/mta-ui/proc_generating-deployment-assets.adoc b/docs/topics/mta-ui/proc_generating-deployment-assets.adoc index 935be365..7074e198 100644 --- a/docs/topics/mta-ui/proc_generating-deployment-assets.adoc +++ b/docs/topics/mta-ui/proc_generating-deployment-assets.adoc @@ -3,12 +3,20 @@ :_mod-docs-content-type: PROCEDURE [id="generating-deployment-assets_{context}"] -= Generating deployment assets += Generating deployment assets by using a discovery manifest [role="_abstract"] -To prepare your application for deployment to a container platform, generate deployment assets in the {ProductFullName} user interface (UI). +To prepare your application for deployment to a container platform, generate deployment assets by using a discovery manifest in the {ProductFullName} user interface (UI). -When you generate assets for an application, the generators render manifests for all the migration paths associated with the archetype of the application. +When you generate assets for an application, the generators render manifests for all the migration paths associated with the archetype of the application. + +You can generate application assets by using only source code, without generating a discovery manifest first. If a discovery manifest is unavailable, the generator uses the following implicit data from the application profile for opinionated asset generation: + +* *Application metadata:* Information such as the application name, version, and unique identifiers. +* *Application archetypes:* Standardized templates or structures identified during the initial analysis. +* *Identified application tags:* The generator applies logic based on the tags found during analysis. For example: +** For Quarkus, it configures specific environment variables for native-mode deployments. +** For Spring Boot, it applies standard Spring framework configurations and dependencies to the generated manifests. .Prerequisites diff --git a/docs/topics/mta-ui/proc_generating-discovery-manifest-web.adoc b/docs/topics/mta-ui/proc_generating-discovery-manifest-web.adoc index f4608e9c..d926127a 100644 --- a/docs/topics/mta-ui/proc_generating-discovery-manifest-web.adoc +++ b/docs/topics/mta-ui/proc_generating-discovery-manifest-web.adoc @@ -8,7 +8,12 @@ [role="_abstract"] To validate your application inventory before performing a full analysis, generate a discovery manifest in the {ProductFullName} user interface (UI). -To generate discovery manifest, you must retrieve the application configuration from the Cloud Foundry (CF) source platform instance. {ProductShortName} generates a discovery manifest that has the application configuration, which you can later use to generate assets (deployment manifests). +To generate a discovery manifest, you must retrieve the application configuration from the Cloud Foundry (CF) source platform instance. {ProductShortName} generates a discovery manifest that contains the application configuration, which you can later use to generate assets (deployment manifests). + +[NOTE] +==== +As an Architect, you can generate application assets by using only source code, without generating a discovery manifest first. If a discovery manifest is unavailable, the generator uses implicit data from the application profile for opinionated asset generation. +==== You can retrieve configuration for one or more applications at a time. @@ -28,7 +33,7 @@ You can retrieve configuration for one or more applications at a time. ... Click *Retrieve Configurations*. * Retrieve configurations for multiple applications: -... Select the target applications or click the Select all option (image:select.png[]). +... Select the target applications or click the *Select all* option. ... Click the Options menu near *Analyze* at the top and click *Retrieve Configurations*. + . You can review the read-only configurations in the *Retrieve Configurations* dialog and click *Retrieve*. diff --git a/docs/topics/mta-ui/proc_importing-an-app-list.adoc b/docs/topics/mta-ui/proc_importing-an-app-list.adoc index a1ec2c32..72ae9a46 100644 --- a/docs/topics/mta-ui/proc_importing-an-app-list.adoc +++ b/docs/topics/mta-ui/proc_importing-an-app-list.adoc @@ -7,9 +7,9 @@ = Importing a list of applications [role="_abstract"] -To streamline the process of adding and preparing multiple applications for an analysis, import an application list into the {ProductFullName} user interface (UI). +To add and prepare multiple applications for analysis, import an application list into the {ProductFullName} user interface (UI). -You can add multiple applications in bulk by using a `.csv` file and importing this file to the {ProductShortName} UI. +You can add several applications in bulk by using a comma-separated values (CSV) file and importing this file to the {ProductShortName} UI. NOTE: Importing a list of applications does not overwrite any of the existing applications. diff --git a/docs/topics/mta-ui/proc_reviewing-a-task-log.adoc b/docs/topics/mta-ui/proc_reviewing-a-task-log.adoc index 7e2efa20..c65a8f83 100644 --- a/docs/topics/mta-ui/proc_reviewing-a-task-log.adoc +++ b/docs/topics/mta-ui/proc_reviewing-a-task-log.adoc @@ -14,4 +14,4 @@ To find details and logs of a particular {ProductFullName} task, access the *Tas . Click the *Options* menu ({kebab}) for the selected task. . Click *Task details*. + -Alternatively, click on the task status in the *Status* column. \ No newline at end of file +Alternatively, click the task status in the *Status* column. \ No newline at end of file diff --git a/docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc b/docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc index 6ad4d3d1..b1dfefde 100644 --- a/docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc +++ b/docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc @@ -12,7 +12,7 @@ To review analysis details, such as analysis steps, access the activity log in t .Procedure . In the *Migration* view, click *Application inventory*. -. Click on the application row to open the application drawer. +. Click the application row to open the application drawer. . Click the *Reports* tab. . Click *View analysis details* for the activity log of the analysis. . Optional: For issues and dependencies found during the analysis, click the *Details* tab in the application drawer and click *Issues* or *Dependencies*. diff --git a/docs/topics/mta-ui/proc_reviewing-an-archetype.adoc b/docs/topics/mta-ui/proc_reviewing-an-archetype.adoc index fe904a4b..f85d8171 100644 --- a/docs/topics/mta-ui/proc_reviewing-an-archetype.adoc +++ b/docs/topics/mta-ui/proc_reviewing-an-archetype.adoc @@ -8,27 +8,27 @@ [role="_abstract"] To verify the scope and criteria of the assessments of applications with similar characteristics, review an archetype in the {ProductFullName} user interface (UI). -An archetype is considered reviewed after completing the review process once, even if multiple questionnaires are marked as required. +The {ProductShortName} marks an archetype as reviewed after you complete the review process once, even if multiple questionnaires are necessary. -NOTE: If an application is associated with several archetypes, this application is considered reviewed when all associated archetypes have been reviewed. +NOTE: If you associate an application with several archetypes, the {ProductShortName} marks the application as reviewed only after you review all of its associated archetypes. .Prerequisites -* You are logged in to an {ProductShortName} server. +* You are logged in to an {ProductShortName} server. .Procedure . Open the {ProductShortName} web console. . Select the *Migration* view and click *Archetype*. . Click the *Options* menu ({kebab}) and select *Review* from the drop-down menu. -. From the list of available questionnaires, click *Take* to select the desired assessment questionnaire. +. From the list of available questionnaires, select the desired assessment questionnaire by clicking *Take*. . In the *Assessment* menu, answer the required questions. -. Select *Save and Review*. You will automatically be redirected to the *Review* tab. +. Select *Save and Review*. The system automatically redirects you to the *Review* tab. . Enter the following information: -** *Proposed Action*: Proposed action required to complete the migration or modernization of the archetype. +** *Proposed Action*: A proposed action required to complete the migration or modernization of the archetype. ** *Effort estimate*: The level of effort required to perform the modernization or migration of the selected archetype. -** *Business criticality*: The level of criticality of the application to the business. -** *Work Priority*: The archetype’s priority. +** *Business criticality*: The level of criticality of the application to the business. +** *Work Priority*: The archetype's priority. -. Click *Submit review*. \ No newline at end of file +. Click *Submit review*. \ No newline at end of file diff --git a/docs/topics/mta-ui/proc_reviewing-assessment-report.adoc b/docs/topics/mta-ui/proc_reviewing-assessment-report.adoc index 7b184edf..0dd9ed03 100644 --- a/docs/topics/mta-ui/proc_reviewing-assessment-report.adoc +++ b/docs/topics/mta-ui/proc_reviewing-assessment-report.adoc @@ -7,7 +7,9 @@ = Reviewing an assessment report [role="_abstract"] -To identify migration risks and estimate the effort required for modernization, review the assessment report in the {ProductFullName} user interface (UI). A {ProductShortName} assessment report displays an aggregated assessment of the data obtained from multiple questionnaires for multiple applications. + +To identify migration risks and estimate modernization effort, review the assessment report in the {ProductFullName} user interface (UI). You can use this report to view aggregated data from multiple application questionnaires for different applications. + .Procedure diff --git a/docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc b/docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc index 94216be2..a300b178 100644 --- a/docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc +++ b/docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc @@ -13,29 +13,27 @@ As a Migrator, you can use a pre-configured analysis profile to analyze an appli . In the *Migration* view, click *Application inventory*. . Select an application that you want to analyze. -+ . Review the credentials assigned to the application. . Click *Analyze*. . In the *Mode* section, select *Use analysis profile*. -. Select a pre-configured profile from the list to run an analysis. -. Click *Next* -. *Enable automated tagging*. Select the checkbox to automatically attach tags to the application. This checkbox is selected by default. -+ -NOTE: {ProductShortName} displays automatically attached tags only _after_ you run the analysis. You can attach tags to the application manually instead of enabling automated tagging or in addition to it. -+ -. *Enable enhanced analysis details*. If you enable this option, {ProductShortName} uploads the logs and output of commands that you run to the Hub as the output streams. The information logged includes the analyzer raw report. +. Select a pre-configured profile from the list to run an analysis. +. Click *Next*. +. *Enable automated tagging*. Select the check box to automatically attach tags to the application. + +NOTE: The {ProductShortName} displays automatically attached tags only after you run the analysis. You can attach tags to the application manually instead of enabling automated tagging or in addition to it. + +. *Enable enhanced analysis details*. If you enable this option, {ProductShortName} uploads the logs and output of commands that you run to the Hub as the output streams. The information includes the analyzer raw report. //need more information on the above option. . Click *Next*. . In *Review*, verify the analysis parameters. . Click *Run*. + -The analysis status is `Scheduled` as {ProductShortName} downloads the image for the container. When {ProductShortName} downloads the image, the status changes to `In-progress.` +The analysis status is `Scheduled` while {ProductShortName} downloads the container image. After the download completes, the status changes to `In-progress`. + -NOTE: Analysis takes minutes to hours to run depending on the size of the application and the capacity and resources of the cluster. +The analysis takes minutes to hours depending on the size of the application and the capacity and resources of the cluster. + -NOTE: {ProductShortName} relies on Kubernetes scheduling capabilities to determine how many analyzer instances are created based on cluster capacity. If several applications are selected for analysis, by default, only one analyzer can be provisioned at a time. With more cluster capacity, more analysis processes can be executed in parallel. +NOTE: The {ProductShortName} uses Kubernetes scheduling capabilities to determine how many analyzer instances to create based on cluster capacity. By default, if you select multiple applications for analysis, the {ProductShortName} provisions only one analyzer at a time. With additional cluster capacity, the {ProductShortName} can execute more analysis processes in parallel. . Optional: To track the status of your active analysis task, open the *Task Manager* view by clicking the notifications button. + @@ -43,13 +41,12 @@ Alternatively, hover over the application name to display the pop-over window. .Verification -To check the report after the analysis is complete: +* Check the report after the analysis is complete: . Open the application view by clicking on the application name. -. Click the *Reports* tab to download the results in *HTML* or *YAML*. +. Click the *Reports* tab to download the results in the HTML or YAML format. + - [NOTE] ==== -You can download the report if the {ProductShortName} Administrator has enabled the option to download reports after running an analysis on the *General configuration* page in the *Administration* view. +You can download the report after running an analysis if the {ProductShortName} Administrator enables the download option on the *General configuration* page in the *Administration* view. ==== \ No newline at end of file diff --git a/docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc b/docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc index 6e7eb53c..22d486ca 100644 --- a/docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc +++ b/docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc @@ -7,7 +7,7 @@ = The custom questionnaire fields [role="_abstract"] -To correctly build a custom assessment questionnaire for the {ProductFullName} user interface (UI), view the following questionnaire fields. These definitions provide the necessary knowledge for configuring questions, answers, and weighting. +You can build a custom assessment questionnaire in the {ProductFullName} user interface (UI) by configuring specific fields. These field definitions help you configure questions, answers, and weighting. Every custom questionnaire field marked as _required_ is mandatory. If you do not define such fields, YAML validation will fail on upload. Each subsection of the field defines a new structure or object in YAML, for example: @@ -30,46 +30,45 @@ thresholds: |Questionnaire field|Description |`name` (required, string) |The name of the questionnaire. This field must be unique for the entire {ProductShortName} instance. |`description` (optional, string)|A short description of the questionnaire. -|`thresholds` (required) a|The definition of a threshold for each risk category of the application or archetype that is considered to be affected by that risk level. The threshold values can be the following: +|`thresholds` (required) a|The definition of a threshold for each application or archetype risk category that the risk level affects. Valid threshold values include the following: -* `red` (required, unsigned integer): Numeric percentage, for example, `30` for `30%`, of red answers that the questionnaire can have until the risk level is considered red. -* `yellow` (required, unsigned integer): Numeric percentage, for example, `30` for `30%`, of yellow answers that the questionnaire can have until the risk level is considered yellow. -* `unknown` (required, unsigned integer): Numeric percentage, for example, `30` for `30%`, of unknown answers that the questionnaire can have until the risk level is considered -unknown. +* `red` (required, unsigned integer): The numeric percentage of red answers allowed in the questionnaire before the {ProductShortName} marks the risk level as red, for example, `30` for `30%`. +* `yellow` (required, unsigned integer): The numeric percentage of yellow answers allowed in the questionnaire before the {ProductShortName} marks the risk level as yellow, for example, `30` for `30%`. +* `unknown` (required, unsigned integer): The numeric percentage of unknown answers allowed in the questionnaire before the {ProductShortName} marks the risk level as unknown. -The higher risk level always takes precedence. For example, if the `yellow` threshold is set to 30% and `red` to 5%, and the answers for the application or archetype are set to have 35% `yellow` and 6% `red`, the risk level for the application or archetype is red. +The higher risk level always takes precedence. For example, if you set the `yellow` threshold to 30% and `red` to 5%, and set the answers for the application or archetype to have 35% `yellow` and 6% `red`, the risk level for the application or archetype is red. -|`riskMessages` (required) a| Messages to be displayed in reports for each risk category. The _risk_messages_ map is defined by the following fields: +|`riskMessages` (required) a| The messages that reports display for each risk category. The following fields define the risk messages map: -* `red` (required, string): A message to be displayed in reports for the red risk level. -* `yellow` (required, string): A message to be displayed in reports for the yellow risk level. -* `green` (required, string): A message to be displayed in reports for the green risk level. -* `unknown` (required, string): A message to be displayed in reports for the unknown risk level. +* `red` (required, string): A message that reports display for the red risk level. +* `yellow` (required, string): A message that reports display for the yellow risk level. +* `green` (required, string): A message that reports display for the green risk level. +* `unknown` (required, string): A message that reports display for the unknown risk level. |`sections` (required) a|A list of sections that the questionnaire must include. -* `name` (required, string): A name to be displayed for the section. +* `name` (required, string): A name of the section. * `order` (required, integer): An order of the question in the section. * `comment` (optional, string): A description of the section. * `questions` (required): A list of questions that belong to the section. ** `order` (required, integer): An order of the question in the section. -** `text` (required, string): A question to be asked. +** `text` (required, string): A question to include in the questionnaire. ** `explanation` (optional, string): An additional explanation for the question. -** `includeFor` (optional): A list that defines if a question must be displayed if any of the tags included in this list is present in the target application or archetype. +** `includeFor` (optional): A list that defines whether the {ProductShortName} displays the question if the application or archetype contains any of the listed tags. *** `category` (required, string): A category of the target tag. *** `tag` (required, string): A target tag. -** `excludeFor` (optional): A list that defines if a question must be skipped if any of the tags included in the list is present in the target application or archetype. +** `excludeFor` (optional): A list that defines whether the {ProductShortName} skips the question if the application or archetype contains any of the listed tags. *** `category` (required, string): A category of the target tag. *** `tag` (required, string): A target tag. ** `answers` (required): A list of answers for the given question. *** `order` (required, integer): An order of the question in the section. *** `text` (required, string): An answer for the question. *** `risk` (required): An implied risk level (red, yellow, green, or unknown) of the current answer. -*** `rationale` (optional, string): A justification for the answer that is being considered a risk. +*** `rationale` (optional, string): A justification for the answer considered a risk. *** `mitigation` (optional, string): An explanation of the potential mitigation strategy for the risk implied by the answer. -*** `applyTags` (optional): A list of tags to be automatically applied to the assessed application or archetype if this answer is selected. +*** `applyTags` (optional): A list of tags that the {ProductShortName} automatically applies to the assessed application or archetype if this answer is selected. **** `category` (required, string): A category of the target tag. **** `tag` (required, string): A target tag. -*** `autoAnswerFor` (optional, list): A list of tags that will lead to this answer being automatically selected when the application or archetype is assessed. +*** `autoAnswerFor` (optional, list): A list of tags that prompt the {ProductShortName} to automatically select this answer when it assesses the application or archetype: **** `category` (required, string): A category of the target tag. **** `tag` (required, string): A target tag. |==== diff --git a/docs/topics/release-notes-topics/ref_fixed-issues-8-1-1.adoc b/docs/topics/release-notes-topics/ref_fixed-issues-8-1-1.adoc new file mode 100644 index 00000000..327cb974 --- /dev/null +++ b/docs/topics/release-notes-topics/ref_fixed-issues-8-1-1.adoc @@ -0,0 +1,21 @@ +:_newdoc-version: 2.18.7 +:_template-generated: 2026-04-15 +:_mod-docs-content-type: REFERENCE + +[id="fixed-issues-8-1-1_{context}"] += Fixed issues + +[role="_abstract"] +{ProductFirstRef} ({ProductShortName}) version 8.1.1 provides the following fixed issues that have a significant impact. + +The Application discovery manifest in the {ProductShortName} UI displays YAML-formatted content:: +Before this update, the Application discovery manifest in the {ProductFullName} user interface (UI) did not display YAML-formatted content. As a consequence, you could only see raw JSON data that included all database record metadata instead of formatted YAML. With this release, the Application discovery manifest includes only YAML-formatted content fields. ++ +(link:https://redhat.atlassian.net/browse/MTA-6774[MTA-6774]) + + +The {ProductShortName} UI generates assets for applications without a discovery manifest:: +Before this update, the {ProductFullName} user interface (UI) did not allow you to generate assets for applications without an associated discovery manifest. As a consequence, you could not generate assets for applications with only source code that had not been discovered in a source platform. With this update, {ProductShortName} supports generating assets for applications without a discovery manifest. As a result, you can use the {ProductShortName} UI to generate these assets, which enhances deployment flexibility. ++ +(link:https://redhat.atlassian.net/browse/MTA-6788[MTA-6788]) + diff --git a/docs/topics/release-notes-topics/ref_fixed-issues-8-1-2.adoc b/docs/topics/release-notes-topics/ref_fixed-issues-8-1-2.adoc new file mode 100644 index 00000000..0cdd0156 --- /dev/null +++ b/docs/topics/release-notes-topics/ref_fixed-issues-8-1-2.adoc @@ -0,0 +1,15 @@ +:_newdoc-version: 2.18.7 +:_template-generated: 2026-05-06 +:_mod-docs-content-type: REFERENCE + +[id="fixed-issues-8-1-2_{context}"] += Fixed issues + +[role="_abstract"] +{ProductFirstRef} ({ProductShortName}) version 8.1.2 provides the following fixed issues that have a significant impact. + +The C# analyzer accurately calculates code snippet boundaries:: +Before this update, when analyzing C# applications, the {ProductFullName} incorrectly calculated the boundaries for code snippets when rule violations occurred further down in a source file. As a consequence, the `codesnip` section in the analysis output cut off right before the violation, failing to display the actual line of code causing the issue. With this update, the C# analyzer provider properly calculates the code snippet boundaries to include the affected lines. As a result, the generated code snippets in the analysis output correctly display the exact violation line numbers and their full context. ++ +(link:https://redhat.atlassian.net/browse/MTA-6898[MTA-6898]) + diff --git a/docs/topics/templates/document-attributes.adoc b/docs/topics/templates/document-attributes.adoc index b2c379d8..94091527 100644 --- a/docs/topics/templates/document-attributes.adoc +++ b/docs/topics/templates/document-attributes.adoc @@ -3,11 +3,11 @@ // * Standard document attributes * // ******************************** :toc: -:toclevels: 3 +:toclevels: 4 :numbered: :imagesdir: topics/images :topicsdir: topics - +:_mod-docs-content-type: ATTRIBUTES // ***************** // * Product names * // ***************** @@ -26,14 +26,14 @@ ifdef::mta[] :WebNameTitle: User Interface :WebNameURL: user_interface_guide :WebConsoleBookName: {WebNameTitle} Guide -:ProductVersion: 8.1.0 +:ProductVersion: 8.1.2 :PluginName: MTA plugin :mta-dl-full: Red Hat Developer Lightspeed for migration toolkit for applications :mta-dl-plugin: Red Hat Developer Lightspeed for MTA :mta-URL: https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/{DocInfoProductNumber}/html-single -:ProductDistributionVersion: 8.1.0.GA-redhat -:ProductDistribution: mta-8.1.0.GA-cli-offline.zip +:ProductDistributionVersion: 8.1.2.GA-redhat +:ProductDistribution: mta-8.1.2.GA-cli-offline.zip :DevDownloadPageURL: https://developers.redhat.com/products/mta/download :JiraWindupURL: https://issues.redhat.com/projects/MTA/issues // OpenShift diff --git a/docs/topics/vscode/proc_installing-vscode-extension.adoc b/docs/topics/vscode/proc_installing-vscode-extension.adoc index acf31220..b5b2f81d 100644 --- a/docs/topics/vscode/proc_installing-vscode-extension.adoc +++ b/docs/topics/vscode/proc_installing-vscode-extension.adoc @@ -3,7 +3,21 @@ = Installing the {ProductShortName} extension for Visual Studio Code [role="_abstract"] -You can use the {ProductFullName} Visual Studio Code plugin to perform a standard application analysis. You can also enable Red Hat Developer Lightspeed for the {ProductName} to use Generative AI (GenAI) capabilities to fix code issues before migrating to target technologies. Note that Developer Lightspeed for {ProductShortName} is enabled by default. For more information, see link:{mta-URL}/configuring_and_using_red_hat_developer_lightspeed_for_mta/index[Configuring and using Developer Lightspeed for {ProductShortName}]. +Install the {ProductFullName} extension pack or the {ProductShortName} Core extension with a language-specific extension to perform an application analysis. Use the extension pack to analyze in all supported languages or the Core and a language-specific plugin to optimize the memory usage. + +You can install the following language-specific {ProductShortName} Visual Studio Code extensions from the Visual Studio Code Marketplace: + +* `Java` +* `JavaScript` to analyze `JavaScript` and `Node.js` applications +* `C#` to analyze `C#` and `.NET` applications +* `Go` + +:FeatureName: `Extension pack`, `C#`, `JavaScript`, and `Go` extensions +[IMPORTANT] +==== +{FeatureName} are Developer Preview features only. Developer Preview features are not supported by Red{nbsp}Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red{nbsp}Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red{nbsp}Hat might provide ways to submit feedback on Developer Preview features without an associated service level agreement (SLA). +==== +:!FeatureName: .Prerequisites @@ -19,4 +33,9 @@ You can use the {ProductFullName} Visual Studio Code plugin to perform a standar .Procedure -* Install the {ProductShortName} {ProductVersion} Visual Studio Code plugin from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code Marketplace]. +* Install the {ProductShortName} {ProductVersion} Visual Studio Code plugin from the Visual Studio Code Marketplace. + +.Additional resources +* link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code Marketplace] +* link:{mta-URL}/configuring_and_using_red_hat_developer_lightspeed_for_mta/index[Configuring and using Developer Lightspeed for {ProductShortName}] +* link:https://access.redhat.com/support/offerings/devpreview[Developer Preview Support Scope] diff --git a/method-discover.adoc b/method-discover.adoc index f4972d2d..4ee5a416 100644 --- a/method-discover.adoc +++ b/method-discover.adoc @@ -2,7 +2,7 @@ // // * docs/getting-started-guide/master.adoc -:_content-type: CONCEPT +:_mod-docs-content-type: CONCEPT [id="method-discover_{context}"] = Discover phase @@ -13,4 +13,4 @@ The _Discover_ phase is when you gather all stakeholders and decision-makers tog In this phase, you explore technologies and discuss potential approaches. Identify the existing pain points, concerns, requirements, and some potential challenges. Define the high-level business priorities and scope of the assessment. Determine in what ways you want to modernize your application development and delivery to allow you to innovate more rapidly. -Typically, this can be covered in a day in a workshop with Red Hat experts. \ No newline at end of file +Typically, this can be covered in a day in a workshop with Red Hat experts. From 209ae7461dcc96639310f09c4c89dae04b82f059 Mon Sep 17 00:00:00 2001 From: Prabha Kylasamiyer Sundara Rajan Date: Fri, 29 May 2026 07:53:33 +0530 Subject: [PATCH 3/4] Resolved merge conflict Signed-off-by: Prabha Kylasamiyer Sundara Rajan --- .../developer-lightspeed/con_intro-to-developer-lightspeed.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc index 5f3c14b2..bfb7c451 100644 --- a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc +++ b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc @@ -41,4 +41,3 @@ Migrators do duplicate work by resolving issues that repeat across applications .Additional resources * link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope] :!intro-to-the-developer-lightspeed: - From e8d5f9a14ed00eb4582369380d07ff4412bf1f56 Mon Sep 17 00:00:00 2001 From: Prabha Kylasamiyer Sundara Rajan Date: Fri, 29 May 2026 08:04:11 +0530 Subject: [PATCH 4/4] Moved links to additional resources section Signed-off-by: Prabha Kylasamiyer Sundara Rajan --- .../con_developer-lightspeed-pathways.adoc | 2 +- .../con_intro-to-developer-lightspeed.adoc | 1 + .../topics/developer-lightspeed/con_solution_server.adoc | 1 + .../proc_tackle-enable-llm-proxy.adoc | 6 +++++- .../ref_example-code-suggestion.adoc | 9 +++++++-- 5 files changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc b/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc index df043037..fb09bb32 100644 --- a/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc +++ b/docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc @@ -84,4 +84,4 @@ As a Migrator, you can: * link:{mta-URL}/configuring_and_using_the_visual_studio_code_extension_for_mta/index#analyzing-application-profiles_vsc-extension-guide[Running an application analysis by using a profile] -* xref:apply-rag-resolution_run-dev-lightspeed-analysis[code resolutions that the Solution Server suggests] \ No newline at end of file +* xref:apply-rag-resolution_run-dev-lightspeed-analysis[Code resolutions that the Solution Server suggests] \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc index bfb7c451..3e674189 100644 --- a/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc +++ b/docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc @@ -40,4 +40,5 @@ Migrators do duplicate work by resolving issues that repeat across applications .Additional resources * link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope] + :!intro-to-the-developer-lightspeed: diff --git a/docs/topics/developer-lightspeed/con_solution_server.adoc b/docs/topics/developer-lightspeed/con_solution_server.adoc index f2a9c1c7..1b7c592f 100644 --- a/docs/topics/developer-lightspeed/con_solution_server.adoc +++ b/docs/topics/developer-lightspeed/con_solution_server.adoc @@ -43,4 +43,5 @@ When you use the Solution Server, you can view a diff of the updated portions of .Additional resources * link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope] + :!solution-server: diff --git a/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc b/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc index a2b21dde..a3d5a43f 100644 --- a/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc +++ b/docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc @@ -17,7 +17,7 @@ To use the Solution Server, the Administrator must enable it in the Tackle CR al .Prerequisites -* You deployed an additional ReadWriteOnce (`RWO`) volume for the `{mta-dl-plugin}-database` if you want to use {mta-dl-plugin}. See link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] for more information. +* You deployed an additional ReadWriteOnce (`RWO`) volume for the `{mta-dl-plugin}-database` if you want to use {mta-dl-plugin}. See Persistent volume requirements for more information. * You installed the {ProductShortName} Operator v8.1.0 or later. @@ -76,3 +76,7 @@ $ *oc get deploy,svc -n openshift-mta | grep -E 'kai-(api|db|importer)'* When you enable Solution Server, the {ProductShortName} Hub serves the Solution Server API endpoint. You need not complete any further task, such as creating a route for the Solution Server API. ==== +[role="_additional-resources"] +.Additional resources + +* link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] \ No newline at end of file diff --git a/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc b/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc index 44410f46..e45957d1 100644 --- a/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc +++ b/docs/topics/developer-lightspeed/ref_example-code-suggestion.adoc @@ -12,7 +12,7 @@ Generate code fixes for a Java application you want to migrate to the target tec . Open the `my-Java` project in Visual Studio Code. -. Download the {mta-dl-full} extension from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code marketplace]. +. Download the {mta-dl-full} extension from the Visual Studio Code marketplace. . Type `Ctrl+Shift+P` (Windows and Linux systems) or `Cmd+Shift+P` (Mac systems). @@ -67,4 +67,9 @@ You can review the code changes in the editor and accept or reject the changes. + This round of analysis detects lint issues, compilation issues, or diagnostic issues that can occur when you accepted the suggested code change. + -Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you allow until it resolves all issues. \ No newline at end of file +Repeat the review and accept or reject the resolutions. {mta-dl-plugin} continues to run repeated iterations of scan if you allow until it resolves all issues. + +[role="_additional-resources"] +.Additional resources + +* link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code marketplace] \ No newline at end of file