Skip to content

Commit

Permalink
Merge pull request #7293 from chamindi-a/chamindi-blf1
Browse files Browse the repository at this point in the history
Correcting broken images and other links
  • Loading branch information
npamudika authored Oct 2, 2023
2 parents 8cb0e60 + d54d4d8 commit 7eab7b4
Show file tree
Hide file tree
Showing 42 changed files with 50 additions and 55 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -461,4 +461,4 @@ When registering a third-party Identity Provider as a Key Manager in the Admin P
!!! tip
If you want to generate the tokens with scopes, make sure that those scopes are defined in the Authorization Server.

6. You can now use the generated token to [invoke an API]({{base_path}}/en/docs/consume/invoke-apis/invoke-apis-using-tools/include-additional-headers-in-the-api-console.md).
6. You can now use the generated token to [invoke an API]({{base_path}}/consume/invoke-apis/invoke-apis-using-tools/include-additional-headers-in-the-api-console/).
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Follow the instructions given below to configure the ForgeRock Authorization Ser
[![ForgeRock create OAuth Provider]({{base_path}}/assets/img/administer/forgerock-create-oauth-provider.png)]({{base_path}}/assets/img/administer/forgerock-create-oauth-provider.png)

5. Navigate to **Root Realm** -> **Services** add Oauth2 provider as a new service as follows,
[![ForgeRock add OAuth Provider]({{base_path}}/assets/img/administer/forgerock-add-oauth-provider.png)]({{base_path}}/assets/img/administer/forgerock-create-add-provider.png)
[![ForgeRock add OAuth Provider]({{base_path}}/assets/img/administer/forgerock-create-oauth-provider.png)]({{base_path}}/assets/img/administer/forgerock-create-oauth-provider.png)


6. Configure the scopes and the signing algorithm of the created OAuth 2.0 Provider using the following values.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Follow the steps below to configure a parameterized endpoint as the API endpoint
}
}
```
2. Add the created JAR file into the `<API-M_HOME>/repository/components/lib` folder of each Gateway. You can download a sample JAR file [here](https://docs.wso2.com/download/attachments/80713829/env-resolver-1.0.0.jar?version=2&modificationDate=1512985782000&api=v2).<br/><br/>
2. Add the created JAR file into the `<API-M_HOME>/repository/components/lib` folder of each Gateway. You can download a sample JAR file [here](https://wso2.com/documentation/?version=2&modificationDate=1512985782000&api=v2).<br/><br/>
3. Add the following sequence to the `<API-M_HOME>/repository/deployment/server/synapse-configs/sequences` folder of each Gateway.

``` java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Choreo Connect v4.2.0 is only compatible with WSO2 API Manager 4.2.0. Hence you

1. Upgrade WSO2 API Manager version to 4.2.0.

A detailed explanation regarding the above includes in [here]({{base_path}}/install-and-setup/upgrading-wso2-api-manager/320-to-410/upgrading-from-320-to-410/).
A detailed explanation regarding the above includes in [here]({{base_path}}/install-and-setup/upgrading-wso2-api-manager/upgrading-api-manager/ ).

2. Connect Choreo Connect microgateway to API Manager 4.2.0 as a gateway.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To remove request headers from responses for per API or globally, add the name o
``` bash tab="Sample"
<property name="CustomTransportHeader" scope="transport" action="remove"/>
```
Check out [Changing the Default Mediation Flow of API Requests]({{base_path}}/deploy-and-publish/deploy-on-gateway/api-gateway/message-mediation/changing-the-default-mediation-flow-of-api-requests) to learn on how to
Check out [Changing the Default Mediation Flow of API Requests]({{base_path}}/design/api-policies/attach-policy/) to learn on how to
add the above mediation policy per API or globally.

## Handling Error Responses
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Based on the requirement, a single API is exposed to add or retrieve order info

![]({{base_path}}/assets/attachments/103334839/103334831.png)

11. Download the [entitlement-1.0-SNAPSHOT.jar](https://docs.wso2.com/download/attachments/57743363/entitlement-1.0-SNAPSHOT.jar?version=1&modificationDate=1515491619000&api=v2) and add it to the `<API-M_HOME>/repository/components/lib` directory. This JAR file contains the `APIEntitlementCallbackHandler` class which passes the username, HTTP verb and the resource path to the XACML entitlement server. If you want to view the source code of the JAR, go [here](https://github.com/nadeesha5814/XACML-APIManager) .
11. Download the [entitlement-1.0-SNAPSHOT.jar](https://github.com/nadeesha5814/XACML-APIManager/blob/master/target/entitlement-1.0-SNAPSHOT.jar) and add it to the `<API-M_HOME>/repository/components/lib` directory. This JAR file contains the `APIEntitlementCallbackHandler` class which passes the username, HTTP verb and the resource path to the XACML entitlement server. If you want to view the source code of the JAR, go [here](https://github.com/nadeesha5814/XACML-APIManager) .

12. Restart the server once the JAR file is added.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Custom Rate Limiting

Custom rate limiting allows system administrators to define dynamic rules for specific use cases, which are applied globally across all tenants. When a custom rate limiting policy is created, it is possible to define any policy you like. The Traffic Manager acts as the global rate limiting engine and is based on the same technology as WSO2 Complex Event Processor (CEP), which uses the [Siddhi query language](https://docs.wso2.com/complex-event-processor/SiddhiQL+Guide+3.1) . Users are therefore able to create their own custom rate limiting policies by writing custom Siddhi queries. The specific combination of attributes being checked in the policy need to be defined as the key (also called the key template). The key template usually includes a predefined format and a set of predefined parameters. It can contain a combination of allowed keys separated by a colon (:), where each key must start with the prefix $. The following keys can be used to create custom rate limiting policies:
Custom rate limiting allows system administrators to define dynamic rules for specific use cases, which are applied globally across all tenants. When a custom rate limiting policy is created, it is possible to define any policy you like. The Traffic Manager acts as the global rate limiting engine and is based on the same technology as WSO2 Complex Event Processor (CEP), which uses the [Siddhi query language](https://siddhi-io.github.io/siddhi/) . Users are therefore able to create their own custom rate limiting policies by writing custom Siddhi queries. The specific combination of attributes being checked in the policy need to be defined as the key (also called the key template). The key template usually includes a predefined format and a set of predefined parameters. It can contain a combination of allowed keys separated by a colon (:), where each key must start with the prefix $. The following keys can be used to create custom rate limiting policies:

`resourceKey, userId, apiContext, apiVersion, appTenant, apiTenant, appId, clientIp`

Expand Down
2 changes: 1 addition & 1 deletion en/docs/install-and-setup/install-and-setup-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ To set up and configure the Micro Integrator runtime, see the topics given below
<a href="{{base_path}}/install-and-setup/setup/mi-setup/security/securing_management_api">Securing the Management API</a>
</li>
<li>
<a href="{{base_path}}/install-and-setup/setup/mi-setup/customizing_error_pages">Customizing Error Messages</a>
<a href="{{base_path}}/troubleshooting/error-handling/#custom-error-message">Customizing Error Messages</a>
</li>
</ul>
</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The configuration file used for wrapping Java Applications by YAJSW is `wrapper.

!!! info

If you want to set additional properties from an external registry at runtime, store sensitive information like usernames and passwords for connecting to the registry in a properties file and secure it with [secure vault]({{base_path}}/administer/product-security/General/logins-and-passwords/admin-carbon-secure-vault-implementation).
If you want to set additional properties from an external registry at runtime, store sensitive information like usernames and passwords for connecting to the registry in a properties file and secure it with [secure vault]({{base_path}}/install-and-setup/setup/security/logins-and-passwords/working-with-encrypted-passwords/).

!!! note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ The following is an example parameters file for this scenario. (Make sure to spe
```

!!! tip
When importing an API, if you are specifying the endpoint type as `dynamic`, you can include a message mediation policy with a `To` header inside the `Sequences` directory of your API Project. (Refer [Adding Dynamic Endpoints]({{base_path}}/deploy-and-publish/deploy-on-gateway/api-gateway/message-mediation/adding-dynamic-endpoints/#adding-dynamic-endpoints) to learn more about Dynamic endpoints and message mediations associated with that.)
When importing an API, if you are specifying the endpoint type as `dynamic`, you can include a message mediation policy with a `To` header inside the `Sequences` directory of your API Project. (Refer [Adding Dynamic Endpoints]({{base_path}}/design/api-policies/regular-gateway-policies/adding-dynamic-endpoints//) to learn more about Dynamic endpoints and message mediations associated with that.)

### AWS Lambda Endpoints

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ We also recommend the following:
The following steps include how to recover your setup using the backups:

1. Recover the hot-deployment artifacts by replacing the MI_HOME/repository directory with the backed up copy.
2. To recover the databases, follow the recovery strategy recommended by the databases you are using. For information on supported and tested databases, see [Tested Database Management Systems](https://docs.wso2.com/display/compatibility/Tested+DBMSs).
2. To recover the databases, follow the recovery strategy recommended by the databases you are using. For information on supported and tested databases, see [Tested Database Management Systems](https://wso2docs.atlassian.net/wiki/spaces/compatibility/pages/20578309/Tested+DBMSs ).
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@ The complete results can be found [here](https://github.com/wso2/micro-integrato
#### Throughput (requests/sec) vs. concurrent users
The following results compare the throughput against the number of concurrent users for different message sizes.

![Throughput]({{base_path}}/assets/img/setup-and-install/performance-test-results/mi/catplot-throughput-2G-0ms.png)
![Throughput](/assets/img/setup-and-install/performance-test-results/mi/catplot-average-response-time-2G-0ms.png)

#### Average response time (ms) vs. concurrent users
The following results compare the average response time of the Micro Integrator server against the number of users for different message sizes.

![Response Time]({{base_path}}/assets/img/setup-and-install/performance-test-results/mi/catplot-average-response-time-2G-0ms.png)
![Response Time](/assets/img/setup-and-install/performance-test-results/mi/catplot-average-response-time-2G-0ms.png)

Original file line number Diff line number Diff line change
Expand Up @@ -557,8 +557,7 @@ data cleanup task in high load scenarios. To mitigate this, configure the follow
<code>session_data</code> with the required chunk size. This value is in the number of records and depends on the database type and server capacity. It also depends on the amount of load generated by single sign-on (SSO). A higher value increases the chances of deadlocks and a lower value increases the time it takes for a cleanup.</p>
<pre class="java" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><code>[session_data]
cleanup.clean_expired_session_data_in_chunks_of = 8192</code></pre>
<p>For more information on configuring sessions in production, see <a href="https://is.docs.wso2.com/en/5.10
.0/learn/authentication-session-persistence/">Authentication Session Persistence</a> in the WSO2 API Manager
<p>For more information on configuring sessions in production, see <a href="https://is.docs.wso2.com/en/5.10.0/learn/authentication-session-persistence/">Authentication Session Persistence</a> in the WSO2 API Manager
documentation.</p></div></td>
</tr>
<tr class="odd">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Now you have configured the JBoss EAP Server. The next section describes how to
!!! Note
After copying the `jboss-client.jar` file from the `EAP_HOME/bin/client` directory to the `MI_HOME/lib` directory, be sure to remove the `javax.jms` package from the `jboss-client.jar` file.

[![delete package]({{base_path}}/assets/img/integrate/broker-configs/hornetq/delete-package.jpg)]({{base_path}}/assets/img/assets/img/integrate/broker-configs/hornetq/delete-package.jpg)
[![delete package]({{base_path}}/assets/img/integrate/broker-configs/hornetq/delete-package.jpg)]({{base_path}}/assets/img/integrate/broker-configs/hornetq/delete-package.jpg)

Now you have configured WSO2 Micro Integrator with HornetQ embedded in a JBoss EAP server.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can run the scripts on one database instance or set up separate instances fo
</tr>
<tr>
<td>mssql_cluster.sql</td>
<td>This script creates the database tables that are required for <a href='{base_path}}/install-and-setup/setup/mi-setup/deployment/deploying_wso2_ei#cluster-coordination'>cluster coordination</a> (i.e., coordinating the server nodes in your VM deployment).This is only applicable if you have stateful integration artifacts deployed in a clustered setup.
<td>This script creates the database tables that are required for <a href='{{base_path}}/install-and-setup/setup/mi-setup/deployment/deploying_wso2_ei#cluster-coordination'>cluster coordination</a> (i.e., coordinating the server nodes in your VM deployment).This is only applicable if you have stateful integration artifacts deployed in a clustered setup.
</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To configure a Streaming Integrator node to use specific rules templates, follow
```
!!! tip
If required, you can enter a specific rule template under multiple nodes as shown below. Before doing so, ensure the you have selected **Many** for the **Instance Count** field of the template. For more information, see [Creating a Business Rules Template]({{base_path}}/use-cases/streaming-tutorials/creating-business-rules-templates/creating-business-rules-templates/#creating-a-business-rules-template).<br/><br/>
If required, you can enter a specific rule template under multiple nodes as shown below. Before doing so, ensure the you have selected **Many** for the **Instance Count** field of the template. For more information, see [Creating a Business Rules Template]({{base_path}}/use-cases/streaming-tutorials/creating-business-rules-templates/#creating-a-business-rules-template).<br/><br/>
```yaml
deployment_configs:
- <NODE1_HOST_NAME>:<NODE1_PORT>:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ The following tables explain the default data sources configured in the Streamin
<tbody>
<tr class="odd">
<td>Database Access Requirement</td>
<td>To display information relating to the status of your Streaming Integrator deployment, the Status Dashboard needs to retrieve carbon metrics data, registered Streaming Integrator server details and authentication details within the cluster from the database. For more information, see <a href="https://docs.wso2.com/display/SP440/Monitoring+Stream+Processor">Monitoring Stream Processor</a> .</td>
<td>To display information relating to the status of your Streaming Integrator deployment, the Status Dashboard needs to retrieve carbon metrics data, registered Streaming Integrator server details and authentication details within the cluster from the database. For more information, see <a href="https://wso2docs.atlassian.net/wiki/spaces/SP440/overview">Monitoring Stream Processor</a> .</td>
</tr>
<tr class="even">
<td>Required/Optional</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ All configurations related to this tool can be found inside the `<SI_HOME>/wso2/

- **Log file name regex**: The regex patterns defined in all the files in the `<SI_HOME>/wso2/tools/identity-anonymization-tool/conf/log-config` directory are considered.

For information on changing these configurations, see [Configuring the config.json file](https://docs.wso2.com/display/ADMIN44x/Removing+References+to+Deleted+User+Identities+in+WSO2+Products#RemovingReferencestoDeletedUserIdentitiesinWSO2Products-Configuringtheconfig.jsonfile) in the Product Administration Guide.
For information on changing these configurations, see [Configuring the config.json file](https://wso2docs.atlassian.net/wiki/spaces/ADMIN44x/pages/6687734/Removing+References+to+Deleted+User+Identities+in+WSO2+Products#RemovingReferencestoDeletedUserIdentitiesinWSO2Products-MasterConfigConfiguringthemasterconfigurationfile) in the Product Administration Guide.

### Running the Forget-me tool in the standalone mode

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ If you want to allow business users with limited coding knowledge to write busin

## Monitoring the Streaming Integrator

To monitor the performance of your Streaming Integrator setup, configure WSO2 SI to publish its statistics in Dashboards as described in [Configuring Grafana Dashboards]({{base_path}}/install-and-setup/setup/si-setup/setting-up-grafana-dashboards).
To monitor the performance of your Streaming Integrator setup, configure WSO2 SI to publish its statistics in Dashboards as described in [Configuring Grafana Dashboards]({{base_path}}/https://observe/streaming-integrator/setting-up-si-statistics-dashboards/)



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To configure the **Apache ActiveMQ** message broker, follow the steps below:
1. Install [Apache ActiveMQ JMS](http://activemq.apache.org/).

!!!info
This guide uses ActiveMQ versions 5.7.0 - 5.9.0. If you want to use a later version, for instructions on the necessary changes to the configuration steps, go to [Apache ActiveMQ Documentation](http://activemq.apache.org/activemq-580-release.html).
This guide uses ActiveMQ versions 5.7.0 - 5.9.0. If you want to use a later version, for instructions on the necessary changes to the configuration steps, go to [Apache ActiveMQ Documentation](https://activemq.apache.org/activemq-5008000-release).


2. Download the `activemq-client-5.x.x.jar` from [here](https://activemq.apache.org/components/classic/download/).
Expand Down
2 changes: 1 addition & 1 deletion en/docs/integrate/develop/create-kubernetes-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Create a Kubernetes Exporter if you want to deploy your integration solutions in a Kubernetes environment.

The Kubernetes Exporter allows you to package multiple [integration modules]({{base_path}}/integrate/develop/create-integration-project) into a single Docker image. Also, a file named **integration_cr.yaml** is generated, which can be used to carry out Kubernetes deployments based on the [API K8s Operator]({{base_path}}/setup/deployment/kubernetes_deployment/#ei-kubernetes-k8s-operator).
The Kubernetes Exporter allows you to package multiple [integration modules]({{base_path}}/integrate/develop/create-integration-project) into a single Docker image. Also, a file named **integration_cr.yaml** is generated, which can be used to carry out Kubernetes deployments based on the [API K8s Operator]({{base_path}}/install-and-setup/setup/kubernetes-operators/k8s-api-operator/manage-integrations/integration-deployments/).

## Creating the Kubernetes project

Expand Down
2 changes: 1 addition & 1 deletion en/docs/integrate/develop/using-remote-micro-integrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ However, when your solutions are ready to be moved to your production environmen
!!! Note

- If you selected an <b>Enterprise Integrator</b> server in the previous step, enter the port details required for an Enterprise Integrator.
- If you are already running another server on these ports, give unused ports. See [Default ports](../../setup/changing_default_ports) of the Micro Integrator for more information.
- If you are already running another server on these ports, give unused ports. See [Default ports]({{base_path}}/install-and-setup/setup/deployment-best-practices/changing-the-default-ports-with-offset/) of the Micro Integrator for more information.

## Deploy and run artifacts in a remote instance

Expand Down
Loading

0 comments on commit 7eab7b4

Please sign in to comment.