Skip to content

Commit

Permalink
Improvement in Authentication docs. (kedacore#443)
Browse files Browse the repository at this point in the history
Signed-off-by: Shubham Kuchhal <[email protected]>
  • Loading branch information
Shubham82 authored May 11, 2021
1 parent ed0b2bc commit 2075ba2
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions content/docs/1.4/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ For these and other reasons, we also provide a `TriggerAuthentication` resource
apiVersion: keda.k8s.io/v1alpha1
kind: TriggerAuthentication
metadata:
name: {trigger-auth-name}
name: {trigger-authentication-name}
namespace: default # must be same namespace as the ScaledObject
spec:
podIdentity:
Expand All @@ -116,7 +116,7 @@ Every parameter you define in `TriggerAuthentication` definition does not need t
metadata:
param1: {some-value}
authenticationRef:
name: {trigger-authencation-name} # this may define other params not defined in metadata
name: {trigger-authentication-name} # this may define other params not defined in metadata
```

### Environment variable(s)
Expand Down
4 changes: 2 additions & 2 deletions content/docs/1.5/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ For these and other reasons, we also provide a `TriggerAuthentication` resource
apiVersion: keda.k8s.io/v1alpha1
kind: TriggerAuthentication
metadata:
name: {trigger-auth-name}
name: {trigger-authentication-name}
namespace: default # must be same namespace as the ScaledObject
spec:
podIdentity:
Expand Down Expand Up @@ -128,7 +128,7 @@ Every parameter you define in `TriggerAuthentication` definition does not need t
metadata:
param1: {some-value}
authenticationRef:
name: {trigger-authencation-name} # this may define other params not defined in metadata
name: {trigger-authentication-name} # this may define other params not defined in metadata
```

### Environment variable(s)
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.0/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ For these and other reasons, we also provide a `TriggerAuthentication` resource
apiVersion: keda.sh/v1alpha1
kind: TriggerAuthentication
metadata:
name: {trigger-auth-name}
name: {trigger-authentication-name}
namespace: default # must be same namespace as the ScaledObject
spec:
podIdentity:
Expand Down Expand Up @@ -128,7 +128,7 @@ Every parameter you define in `TriggerAuthentication` definition does not need t
metadata:
param1: {some-value}
authenticationRef:
name: {trigger-authencation-name} # this may define other params not defined in metadata
name: {trigger-authentication-name} # this may define other params not defined in metadata
```

### Environment variable(s)
Expand Down
8 changes: 4 additions & 4 deletions content/docs/2.1/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For these and other reasons, we also provide a `TriggerAuthentication` resource
apiVersion: keda.sh/v1alpha1
kind: TriggerAuthentication
metadata:
name: {trigger-auth-name}
name: {trigger-authentication-name}
namespace: default # must be same namespace as the ScaledObject
spec:
podIdentity:
Expand Down Expand Up @@ -129,7 +129,7 @@ Every parameter you define in `TriggerAuthentication` definition does not need t
metadata:
param1: {some-value}
authenticationRef:
name: {trigger-authencation-name} # this may define other params not defined in metadata
name: {trigger-authentication-name} # this may define other params not defined in metadata
```

## Authentication scopes: Namespace vs. Cluster
Expand All @@ -138,7 +138,7 @@ Each `TriggerAuthentication` is defined in one namespace and can only be used by

```yaml
authenticationRef:
name: {trigger-authencation-name}
name: {cluster-trigger-authentication-name}
kind: ClusterTriggerAuthentication
```

Expand All @@ -150,7 +150,7 @@ Defining a `ClusterTriggerAuthentication` works almost identically to a `Trigger
apiVersion: keda.sh/v1alpha1
kind: ClusterTriggerAuthentication
metadata:
name: {cluster-trigger-auth-name}
name: {cluster-trigger-authentication-name}
spec:
# As before ...
```
Expand Down
8 changes: 4 additions & 4 deletions content/docs/2.2/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For these and other reasons, we also provide a `TriggerAuthentication` resource
apiVersion: keda.sh/v1alpha1
kind: TriggerAuthentication
metadata:
name: {trigger-auth-name}
name: {trigger-authentication-name}
namespace: default # must be same namespace as the ScaledObject
spec:
podIdentity:
Expand Down Expand Up @@ -129,7 +129,7 @@ Every parameter you define in `TriggerAuthentication` definition does not need t
metadata:
param1: {some-value}
authenticationRef:
name: {trigger-authencation-name} # this may define other params not defined in metadata
name: {trigger-authentication-name} # this may define other params not defined in metadata
```

## Authentication scopes: Namespace vs. Cluster
Expand All @@ -138,7 +138,7 @@ Each `TriggerAuthentication` is defined in one namespace and can only be used by

```yaml
authenticationRef:
name: {trigger-authencation-name}
name: {cluster-trigger-authentication-name}
kind: ClusterTriggerAuthentication
```

Expand All @@ -150,7 +150,7 @@ Defining a `ClusterTriggerAuthentication` works almost identically to a `Trigger
apiVersion: keda.sh/v1alpha1
kind: ClusterTriggerAuthentication
metadata:
name: {cluster-trigger-auth-name}
name: {cluster-trigger-authentication-name}
spec:
# As before ...
```
Expand Down
8 changes: 4 additions & 4 deletions content/docs/2.3/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For these and other reasons, we also provide a `TriggerAuthentication` resource
apiVersion: keda.sh/v1alpha1
kind: TriggerAuthentication
metadata:
name: {trigger-auth-name}
name: {trigger-authentication-name}
namespace: default # must be same namespace as the ScaledObject
spec:
podIdentity:
Expand Down Expand Up @@ -129,7 +129,7 @@ Every parameter you define in `TriggerAuthentication` definition does not need t
metadata:
param1: {some-value}
authenticationRef:
name: {trigger-authencation-name} # this may define other params not defined in metadata
name: {trigger-authentication-name} # this may define other params not defined in metadata
```

## Authentication scopes: Namespace vs. Cluster
Expand All @@ -138,7 +138,7 @@ Each `TriggerAuthentication` is defined in one namespace and can only be used by

```yaml
authenticationRef:
name: {trigger-authencation-name}
name: {cluster-trigger-authentication-name}
kind: ClusterTriggerAuthentication
```

Expand All @@ -150,7 +150,7 @@ Defining a `ClusterTriggerAuthentication` works almost identically to a `Trigger
apiVersion: keda.sh/v1alpha1
kind: ClusterTriggerAuthentication
metadata:
name: {cluster-trigger-auth-name}
name: {cluster-trigger-authentication-name}
spec:
# As before ...
```
Expand Down

0 comments on commit 2075ba2

Please sign in to comment.