Skip to content

Commit

Permalink
Update from SAP DITA CMS (squashed):
Browse files Browse the repository at this point in the history
commit cfa8428426b8c11ac5ef75a08a8e0b7909911f07
Author: REDACTED
Date:   Tue Jun 11 18:15:28 2024 +0000

    Update from SAP DITA CMS 2024-06-11 18:15:28
    Project: dita-all/jjq1673438782153
    Project map: c2f780f61c744155b0bd42b6f38fb70c.ditamap
    Output: loio3b732a350a824007912ca9a36076c106
    Language: en-US
    Builddable map: 0f934adaa2c9444e8fbf43d72c5803fc.ditamap

commit bdb0b9d5bb40843aa6edb6b1ba6f9b84507d92da
Author: REDACTED
Date:   Tue Jun 11 17:55:06 2024 +0000

    Update from SAP DITA CMS 2024-06-11 17:55:06
    Project: dita-all/jjq1673438782153
    Project map: c2f780f61c744155b0bd42b6f38fb70c.ditamap
    Output: loio3b732a350a824007912ca9a36076c106
    Language: en-US
    Builddable map: 0f934adaa2c9444e8fbf43d72c5803fc.ditamap

commit 9fa8e863c188809e737cbc6df5a3939117de8ab1
Merge: 8e22f46 7bb0e60
Author: REDACTED
Date:   Thu Jun 6 10:05:04 2024 +0200

    Merge pull request #2 from UACP/update_dep5

    Update dep5 and readme

commit 7bb0e604fa06b335a173f32047e875a90b83ba58

##################################################
[Remaining squash message was removed before commit...]
  • Loading branch information
ditaccms-bot committed Jun 12, 2024
1 parent 88a6559 commit 8cf77c6
Show file tree
Hide file tree
Showing 15 changed files with 2,549 additions and 9 deletions.
8 changes: 4 additions & 4 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: YOUR-REPOSITORY
Upstream-Contact: NAME SURNAME (EMAIL)
Source: https://github.com/sap-docs/YOUR-REPOSITORY
Upstream-Name: SAP-docs/btp-application-autoscaler
Upstream-Contact: Sylvia Hoerdt (sylvia.hoerdt@sap.com)
Source: https://github.com/sap-docs/btp-application-autoscaler

Files: *
Copyright: 2024 SAP SE or an SAP affiliate company and YOUR-REPOSITORY contributors
Copyright: 2024 SAP SE or an SAP affiliate company and SAP-docs/btp-application-autoscaler contributors
License: CC-BY-4.0
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-docs/YOUR-REPO-NAME)](https://api.reuse.software/info/github.com/SAP-docs/YOUR-REPO-NAME)
[![REUSE status](https://api.reuse.software/badge/github.com/SAP-docs/btp-application-autoscaler)](https://api.reuse.software/info/github.com/SAP-docs/btp-application-autoscaler)

# Contributions to YOUR-DOCUMENTATION
# Contributions to Application Autoscaler

Found a mistake in our documentation? Always wanted to add a step in one of our procedures that could save many others much time? Then you're at the right place! All contributions made to the Markdown files in the [docs](docs) directory are reviewed, and if deemed valuable be added to our [official documentation on SAP Help Portal](YOUR-LINK). The easiest way is to start there, and choose _Edit_ to find the right Markdown file to contribute to.
Found a mistake in our documentation? Always wanted to add a step in one of our procedures that could save many others much time? Then you're at the right place! All contributions made to the Markdown files in the [docs](docs) directory are reviewed, and if deemed valuable be added to our [official documentation on SAP Help Portal](https://help.sap.com/docs/application-autoscaler/application-autoscaler/what-is-application-autoscaler?version=Cloud). The easiest way is to start there, and choose _Edit_ to find the right Markdown file to contribute to.

## Requirements

Expand All @@ -11,9 +11,9 @@ For contributions, it's required that you have a GitHub account. For more inform

## Contributing

We recommend using the YOUR-DOCUMENTATION documentation on SAP Help Portal as a starting point for contributions:
We recommend using the Application Autoscaler documentation on SAP Help Portal as a starting point for contributions:

1. Open the [YOUR-DOCUMENTATION Documentation](YOUR-LINK).
1. Open the [Application Autoscaler documentation](https://help.sap.com/docs/application-autoscaler/application-autoscaler/what-is-application-autoscaler?version=Cloud).
1. You can either:
* Choose *Feedback* > *Edit page* to suggest a change for the current page you see in the Help Portal viewer, or
* Choose *Feedback* > *Create issue* to open a GitHub issue in this repository.
Expand Down
38 changes: 38 additions & 0 deletions docs/accessibility-features-in-application-autoscaler-94b439d.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!-- loio94b439d4bda34ff291527c44115d3bc5 -->

# Accessibility Features in Application Autoscaler

To optimize your experience of Application Autoscaler, SAP Business Technology Platform \(SAP BTP\) provides features and settings that help you use the software efficiently.



> ### Note:
> Application Autoscaler runs on the SAP BTP cockpit. For this reason, accessibility features for SAP BTP cockpit also apply. See the accessibility documentation for SAP BTP cockpit on SAP Help Portal at [Accessibility Features in SAP BTP Cockpit](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/8153bc43bc7d44009549b375ed5c9632.html).
For more information on screen reader support and keyboard shortcuts, see [Accessibility for End Users](https://help.sap.com/docs/SAPUI5/bc5a64aac808463baa95b4230f221716/f562835d0b4e44129aa24a17551a0baa.html).

Additionally, Application Autoscaler provides high contrast themes. See [Use High Contrast Themes](accessibility-features-in-application-autoscaler-94b439d.md#loio94b439d4bda34ff291527c44115d3bc5__section_rz5_4h5_3qb).



<a name="loio94b439d4bda34ff291527c44115d3bc5__section_rz5_4h5_3qb"/>

## Use High Contrast Themes



### Context

This feature is recommended for users with need for high contrast themes.



### Steps

1. Open the *Application Autoscaler Dashboard*.
2. In the upper right corner of the screen, choose your profile name and then *Choose Theme*.
3. Select the high contrast theme you prefer: *High Contrast Black* or *High Contrast White*.

Your selection is applied automatically.


75 changes: 75 additions & 0 deletions docs/defining-a-custom-metric-87e657e.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<!-- loio87e657e691ac48ba85fd777c042afbd8 -->

# Defining a Custom Metric

Define your own metrics to scale applications based on your requirements.



<a name="loio87e657e691ac48ba85fd777c042afbd8__context_mch_m4g_n4b"/>

## Context

As an alternative to the standard metrics provided by the Application Autoscaler, you can also define custom metrics such as memory consumed in megabytes or in percentage, response time, and throughput for scaling. Custom metrics offer more flexibility, so that you can scale applications based on your own requirements.

To use custom metrics, you need to perform the following tasks:

1. Report a custom metric to the Application Autoscaler by defining a policy.

2. Emit custom metric details using the HTTP API at regular intervals.


The following example shows a policy with a custom metric:

```
{
"instance_min_count":1,
"instance_max_count":4,
"scaling_rules":[
{
"metric_type":"jobqueue",
"breach_duration_secs":60,
"threshold":100,
"operator":">=",
"cool_down_secs":120,
"adjustment":"+1"
}
]
```

> ### Note:
> The metric type used for custom metrics must not be any of the standard metric types.
> ### Tip:
> We recommend a minimum duration of one minute between successive emissions of a custom metric.


## Procedure

1. Bind your application with the Application Autoscaler service instance using a policy that contains custom metrics scaling rule.

2. Read custom metrics binding credentials from the application environment.

> ### Sample Code:
> ```
> "custom_metrics": {
> "mtls_url": "https://autoscaler-metrics-mtls.cf.<landscape>.hana.ondemand.com",
> "password": "some_secret_password",
> "url": "https://autoscaler-metrics.cf.<landscape>.hana.ondemand.com",
> "username": "some_username"
> }
>
> ```
3. Use the X.509 certificate in the file with the path provided in the environment variable `CF_INSTANCE_CERT`, and the private key in the file with the path provided in the environment variable `CF_INSTANCE_KEY` as certificate and key for mutual TLS authentication \(mTLS\) with the base URL provided in the `mtls_url` of the service binding.
> ### Note:
> The X.509 certificate and private key pair are valid for 24 hours. At least 20 minutes before expiration, they are regenerated and new files replace the existing files. Make sure that your code reloads the X.509 certificate and private key pair if they are expired. See [Using Instance Identity Credentials](https://docs.cloudfoundry.org/devguide/deploy-apps/instance-identity.html) in the Cloud Foundry Documentation.
`url`, `username`, and `password` are provided for backwards compatibility with the HTTP basic authentication scheme and should not be used going forward.
4. Push custom metrics at an interval of your choice using APIs. For the REST API specification, see [Application Autoscaler custom metrics API](https://api.sap.com/api/ApplicationAutoscalerCustomMetricsAPI/resource).
28 changes: 28 additions & 0 deletions docs/defining-a-scaling-policy-79f443a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- loio79f443abe6b448ce9b606d10fd816f5c -->

# Defining a Scaling Policy

Define a policy to scale your application instances either dynamically or based on schedules.

To initiate the scaling of an application, you need to define a policy. A policy is a JSON file containing an array of rules or a single rule for scaling. This JSON file is passed while binding the service with the application to be scaled. For more information, see [Initial Setup](initial-setup-f3e7fa9.md).

You can choose between the following types of scaling policies:

- [**Dynamic Scaling Policy**](dynamic-scaling-policy-e6927e5.md)

Scale your application instances based on memory/CPU usage, reponse time, throughput, or custom metrics.

- [**Schedule-Based Scaling Policy**](schedule-based-scaling-policy-204e423.md)

Scale your application instances based on schedules.


**Related Information**


[Parameters for a Dynamic Scaling Policy](parameters-for-a-dynamic-scaling-policy-c966417.md "Get to know the parameters used for dynamic scaling.")

[Parameters for a Schedule-Based Scaling Policy](parameters-for-a-schedule-based-scaling-policy-c8023eb.md "Get to know the parameters used for recurring schedules or specific date schedules.")

[Time Zones for a Schedule-Based Policy](time-zones-for-a-schedule-based-policy-92bceeb.md "Get to know the time zones supported for recurring schedules or specific date schedules.")

21 changes: 21 additions & 0 deletions docs/development-a7620c8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- loioa7620c8ca96848678fda7d222e061091 -->

# Development

Use the Application Autoscaler in your development.

Using the Application Autoscaler in your development comprises the following steps:

- [**Working with the Application Autoscaler Dashboard**](working-with-the-application-autoscaler-dashboard-3ff73fc.md#loio3ff73fce08b44e8d8de0c102d0f64a50)

Access and use the Application Autoscaler dashboard.

- [**Defining a Scaling Policy**](defining-a-scaling-policy-79f443a.md)

Define a policy to scale your application instances either dynamically or based on schedules.

- [**Defining a Custom Metric**](defining-a-custom-metric-87e657e.md)

Define your own metrics to scale applications based on your requirements.


Loading

0 comments on commit 8cf77c6

Please sign in to comment.