Skip to content

Commit

Permalink
Fixing build errors & formatting (kedacore#1)
Browse files Browse the repository at this point in the history 
* formatting tables

removing broken links

correcting typos

correcting link

formatting table

fixing links

Signed-off-by: Nate W <natew@cncf.io>

* Update content/docs/2.15/operate/_index.md

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

---------

Signed-off-by: Nate W <natew@cncf.io>
Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
  • Loading branch information
@nate-double-u @dwelsch-esi
nate-double-u and dwelsch-esi committed May 30, 2024
1 parent 3e68d94 commit bf58480
Show file tree
Hide file tree
Showing 11 changed files with 43 additions and 43 deletions.
10 changes: 5 additions & 5 deletions content/docs/2.15/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Where to go

What is your involvement with KEDA?

| Role | Documentation |
| --- | --- |
| User | This documentation is for users who want to deploy KEDA to scale Kubernetes. |
| Core Contributor | To contribute to the core KEDA project see the [KEDA GitHub repo](https://github.com/kedacore/keda). |
| Role | Documentation |
|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| User | This documentation is for users who want to deploy KEDA to scale Kubernetes. |
| Core Contributor | To contribute to the core KEDA project see the [KEDA GitHub repo](https://github.com/kedacore/keda). |
| Documentation Contributor | To add or contribute to these docs, or to build and serve the documentation locally, see the [keda-docs GitHub repo](https://github.com/kedacore/keda-docs). |
| Other Contributor | See the [KEDA project on GitHub](https://github.com/kedacore/) for other KEDA repos, including project governance, testing, and external scalers. |
| Other Contributor | See the [KEDA project on GitHub](https://github.com/kedacore/) for other KEDA repos, including project governance, testing, and external scalers. |
2 changes: 1 addition & 1 deletion content/docs/2.15/authentication-providers/aws.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This authentication automatically uses both, falling back from [AssumeRoleWithWe

## Setting up KEDA role and policy

The [official AWS docs](https://aws.amazon.com/es/blogs/opensource/introducing-fine-grained-iam-roles-service-accounts/) explain how to set up a a basic configuration for an IRSA role. The policy changes depend if you are using the KEDA role (`podIdentity.roleArn` is not set) or workload role (`podIdentity.roleArn` sets a RoleArn or `podIdentity.identityOwner` sets to `workload`).
The [official AWS docs](https://aws.amazon.com/es/blogs/opensource/introducing-fine-grained-iam-roles-service-accounts/) explain how to set up a basic configuration for an IRSA role. The policy changes depending on if you are using the KEDA role (`podIdentity.roleArn` is not set) or workload role (`podIdentity.roleArn` sets a RoleArn or `podIdentity.identityOwner` sets to `workload`).

### Using KEDA role to access infrastructure

Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.15/concepts/scaling-deployments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,4 +200,4 @@ Using this method can preserve a replica and enable long-running executions. Ho

#### Run as jobs

The other alternative to handling long-running executions is by running the event driven code in Kubernetes Jobs instead of Deployments or Custom Resources. This approach is discussed [in the next section](../scaling-jobs).
The other alternative to handling long-running executions is by running the event driven code in Kubernetes Jobs instead of Deployments or Custom Resources. This approach is discussed [in the next section](./scaling-jobs).
2 changes: 1 addition & 1 deletion content/docs/2.15/concepts/scaling-jobs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This page describes the job scaling behavior of KEDA. See the [Scaled Job specif

# Overview

As an alternate to [scaling event-driven code as deployments](../scaling-deployments) you can also run and scale your code as Kubernetes Jobs. The primary reason to consider this option is to handle processing long-running executions. Rather than processing multiple events within a deployment, for each detected event a single Kubernetes Job is scheduled. That job will initialize, pull a single event from the message source, and process to completion and terminate.
As an alternate to [scaling event-driven code as deployments](./scaling-deployments) you can also run and scale your code as Kubernetes Jobs. The primary reason to consider this option is to handle processing long-running executions. Rather than processing multiple events within a deployment, for each detected event a single Kubernetes Job is scheduled. That job will initialize, pull a single event from the message source, and process to completion and terminate.

For example, if you wanted to use KEDA to run a job for each message that lands on a RabbitMQ queue, the flow may be:

Expand Down
6 changes: 3 additions & 3 deletions content/docs/2.15/deploy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title = "Deploying KEDA"

We provide a few approaches to deploy KEDA runtime in your Kubernetes clusters:

- [Helm charts](#helm)
- [Operator Hub](#operatorhub)
- [YAML declarations](#yaml)
- Helm charts
- Operator Hub
- YAML declarations

> 💡 **NOTE:** KEDA requires Kubernetes cluster version 1.27 and higher
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.15/operate/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We provide guidance and requirements around various areas to operate KEDA:

- Admission Webhooks ([link](./admission-webhooks))
- Cluster ([link](./cluster))
- Kubernetes Events ([link](./events))
- Kubernetes Events ([link](../reference/events))
- KEDA Metrics Server ([link](./metrics-server))
- Integrate with Prometheus ([link](./prometheus))
- Integrate with OpenTelemetry Collector (Experimental) ([link](./opentelemetry))
Expand Down
8 changes: 4 additions & 4 deletions content/docs/2.15/operate/cloud-events.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ eventSubscription: #Optional. Submit included/excluded event types will filter e
```

## Supported Event List
| Event Type | Scenario Description |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `keda.scaledobject.ready.v1` | On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False` |
| `keda.scaledobject.failed.v1` | If the check validation for a ScaledObject fails |
| Event Type | Scenario Description |
|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| `keda.scaledobject.ready.v1` | On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False` |
| `keda.scaledobject.failed.v1` | If the check validation for a ScaledObject fails |
4 changes: 2 additions & 2 deletions content/docs/2.15/reference/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ weight = 2
Reference information for the KEDA autoscaler.

- [Scaled Object specification](./scaledobject-spec)
- [ScaledJob specification](../concepts/scaling-jobs/#scaledjob-spec)
- [ScaledJob specification](./scaledjob-spec.md)
- [Events]
- [Firewall requirements]
- [FAQ](./faq.md)
- [Glossary](./glossary.md)
- [Glossary](./glossary.md)
34 changes: 17 additions & 17 deletions content/docs/2.15/reference/events.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@ weight = 2500
KEDA emits the following [Kubernetes Events](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#event-v1-core):

| Event | Type | Description |
| ------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
|---------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------|
| `ScaledObjectReady` | `Normal` | On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False` |
| `ScaledJobReady` | `Normal` | On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False` |
| `ScaledObjectCheckFailed` | `Warning` | If the check validation for a ScaledObject fails | |
| `ScaledJobCheckFailed` | `Warning` | If the check validation for a ScaledJob fails | |
| `ScaledObjectDeleted` | `Normal` | When a ScaledObject is deleted and removed from KEDA watch | |
| `ScaledJobDeleted` | `Normal` | When a ScaledJob is deleted and removed from KEDA watch | |
| `KEDAScalersStarted` | `Normal` | When Scalers watch loop have started for a ScaledObject or ScaledJob | |
| `KEDAScalersStopped` | `Normal` | When Scalers watch loop have stopped for a ScaledObject or a ScaledJob | |
| `KEDAScalerFailed` | `Warning` | When a Scaler fails to create or check its event source| |
| `KEDAScaleTargetActivated` | `Normal` | When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;...}| |
| `KEDAScaleTargetDeactivated` | `Normal` | When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0 | |
| `KEDAScaleTargetActivationFailed` | `Warning` | When KEDA fails to scale the scale target of a ScaledObject to 1| |
| `KEDAScaleTargetDeactivationFailed` | `Warning` | When KEDA fails to scale the scale target of a ScaledObject to 0| |
| `KEDAJobsCreated` | `Normal` | When KEDA creates jobs for a ScaledJob | |
| `TriggerAuthenticationAdded` | `Normal` | When a new TriggerAuthentication is added| |
| `TriggerAuthenticationDeleted` | `Normal` | When a TriggerAuthentication is deleted| |
| `ClusterTriggerAuthenticationAdded` | `Normal` | When a new ClusterTriggerAuthentication is added| |
| `ClusterTriggerAuthenticationDeleted` | `Normal` | When a ClusterTriggerAuthentication is deleted| |
| `ScaledObjectCheckFailed` | `Warning` | If the check validation for a ScaledObject fails | |
| `ScaledJobCheckFailed` | `Warning` | If the check validation for a ScaledJob fails | |
| `ScaledObjectDeleted` | `Normal` | When a ScaledObject is deleted and removed from KEDA watch | |
| `ScaledJobDeleted` | `Normal` | When a ScaledJob is deleted and removed from KEDA watch | |
| `KEDAScalersStarted` | `Normal` | When Scalers watch loop have started for a ScaledObject or ScaledJob | |
| `KEDAScalersStopped` | `Normal` | When Scalers watch loop have stopped for a ScaledObject or a ScaledJob | |
| `KEDAScalerFailed` | `Warning` | When a Scaler fails to create or check its event source | |
| `KEDAScaleTargetActivated` | `Normal` | When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;...} | |
| `KEDAScaleTargetDeactivated` | `Normal` | When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0 | |
| `KEDAScaleTargetActivationFailed` | `Warning` | When KEDA fails to scale the scale target of a ScaledObject to 1 | |
| `KEDAScaleTargetDeactivationFailed` | `Warning` | When KEDA fails to scale the scale target of a ScaledObject to 0 | |
| `KEDAJobsCreated` | `Normal` | When KEDA creates jobs for a ScaledJob | |
| `TriggerAuthenticationAdded` | `Normal` | When a new TriggerAuthentication is added | |
| `TriggerAuthenticationDeleted` | `Normal` | When a TriggerAuthentication is deleted | |
| `ClusterTriggerAuthenticationAdded` | `Normal` | When a new ClusterTriggerAuthentication is added | |
| `ClusterTriggerAuthenticationDeleted` | `Normal` | When a ClusterTriggerAuthentication is deleted | |
12 changes: 6 additions & 6 deletions content/docs/2.15/reference/scaledjob-spec.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,12 @@ New messages may create new jobs - within the limits imposed by maxReplicaCount
The max number of pods that is created within a single polling period. If there are running jobs, the number of running jobs will be deducted. This table is an example of the scaling logic.

| Queue Length | Max Replica Count | Target Average Value | Running Job Count | Number of the Scale |
| ------- | ------ | ------- | ------ | ----- |
| 10 | 3 | 1 | 0 | 3 |
| 10 | 3 | 2 | 0 | 3 |
| 10 | 3 | 1 | 1 | 2 |
| 10 | 100 | 1 | 0 | 10 |
| 4 | 3 | 5 | 0 | 1 |
|--------------|-------------------|----------------------|-------------------|---------------------|
| 10 | 3 | 1 | 0 | 3 |
| 10 | 3 | 2 | 0 | 3 |
| 10 | 3 | 1 | 1 | 2 |
| 10 | 100 | 1 | 0 | 10 |
| 4 | 3 | 5 | 0 | 1 |

* **Queue Length:** The number of items in the queue.
* **Target Average Value:** The number of messages that will be consumed on a job. It is defined on the scaler side. e.g. `queueLength` on `Azure Storage Queue` scaler.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/reference/scaledobject-spec.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,15 +236,15 @@ For examples of this feature see section [Scaling Modifiers](../concepts/scaling
# {list of triggers to activate scaling of the target resource}
```

> 💡 **NOTE:** You can find all supported triggers [here](/scalers).
> 💡 **NOTE:** You can find all supported triggers [here](../scalers).

Trigger fields:
- **type**: The type of trigger to use. (Mandatory)
- **metadata**: The configuration parameters that the trigger requires. (Mandatory)
- **name**: Name for this trigger. This value can be used to easily distinguish this specific trigger and its metrics when consuming [Prometheus metrics](../operate/prometheus.md). By default, the name is generated from the trigger type. (Optional)
- **useCachedMetrics**: Enables caching of metric values during polling interval (as specified in `.spec.pollingInterval`). For more information, see ["Caching Metrics"](../concepts/scaling-deployments.md#caching-metrics). (Values: `false`, `true`, Default: `false`, Optional)
- **authenticationRef**: A reference to the `TriggerAuthentication` or `ClusterTriggerAuthentication` object that is used to authenticate the scaler with the environment.
- More details can be found [here](./authentication). (Optional)
- More details can be found [here](../concepts/authentication). (Optional)
- **metricType**: The type of metric that should be used. (Values: `AverageValue`, `Value`, `Utilization`, Default: `AverageValue`, Optional)
- Learn more about how the [Horizontal Pod Autoscaler (HPA) calculates `replicaCount`](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/) based on metric type and value.
- To show the differences between the metric types, let's assume we want to scale a deployment with 3 running replicas based on a queue of messages:
Expand Down

0 comments on commit bf58480

Please sign in to comment.