Skip to content

Commit

Permalink
Prepare Changelog and Readme for v0.2.0 release (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
@DTMad
DTMad authored Mar 31, 2021
1 parent 08a7259 commit b256d83
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 23 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

### Future

#### Features
### [v0.2.0](https://github.com/Dynatrace/dynatrace-operator/releases/tag/v0.2.0)

#### Bug fixes
#### Features

#### Other changes
* classicFullStack - The Dynatrace Operator now supports rolling out a fullstack agent
* routing - The Dynatrace Operator now supports rolling out a containerized ActiveGate to route the agent traffic

### [v0.1.0](https://github.com/Dynatrace/dynatrace-operator/releases/tag/v0.1.0)

* Initial release of the Dynatrace Operator
* Initial release of the Dynatrace Operator
63 changes: 44 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,28 @@

The Dynatrace Operator supports rollout and lifecycle of various Dynatrace components in Kubernetes and OpenShift.

As of launch, the Dynatrace Operator can be used to deploy a containerized ActiveGate for Kubernetes API monitoring. New capabilities will be added to the Dynatrace Operator over time including metric routing, and API monitoring for AWS, Azure, GCP, and vSphere.
As of launch, the Dynatrace Operator can be used to deploy a containerized ActiveGate for Kubernetes API monitoring. New
capabilities will be added to the Dynatrace Operator over time including metric routing, and API monitoring for AWS,
Azure, GCP, and vSphere.

With v0.2.0 we added the classicFullStack functionality which allows rolling out the OneAgent to your Kubernetes
cluster. Furthermore, the Dynatrace Operator is now capable of rolling out a containerized ActiveGate for routing the
OneAgent traffic.

## Supported platforms

Depending on the version of the Dynatrace Operator, it supports the following platforms:

| Dynatrace Operator version | Kubernetes | OpenShift Container Platform |
| -------------------------- | ---------- | ------------------------------------------ |
| master | 1.18+ | 3.11.188+, 4.4+ |
| master | 1.18+ | 3.11.188+, 4.5+ |
| v0.2.0 | 1.18+ | 3.11.188+, 4.5+ |
| v0.1.0 | 1.18+ | 3.11.188+, 4.4+ |

## Quick Start

The Dynatrace Operator acts on its separate namespace `dynatrace`. It holds the operator deployment and all dependent objects like permissions, custom resources and corresponding StatefulSets.
The Dynatrace Operator acts on its separate namespace `dynatrace`. It holds the operator deployment and all dependent
objects like permissions, custom resources and corresponding StatefulSets.

#### Kubernetes

Expand All @@ -30,18 +38,24 @@ $ kubectl create namespace dynatrace
$ kubectl apply -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/kubernetes.yaml
```

A secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront.
Create access tokens of type *Dynatrace API* and *Platform as a Service* and use its values in the following commands respectively.
For assistance please refere to [Create user-generated access tokens](https://www.dynatrace.com/support/help/get-started/introduction/why-do-i-need-an-access-token-and-an-environment-id/#create-user-generated-access-tokens).
A secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront. Create access tokens of
type *Dynatrace API* and *Platform as a Service* and use its values in the following commands respectively. For
assistance please refere
to [Create user-generated access tokens](https://www.dynatrace.com/support/help/get-started/introduction/why-do-i-need-an-access-token-and-an-environment-id/#create-user-generated-access-tokens)
.

```sh
$ kubectl -n dynatrace create secret generic dynakube --from-literal="apiToken=DYNATRACE_API_TOKEN" --from-literal="paasToken=PLATFORM_AS_A_SERVICE_TOKEN"
```

#### Create `DynaKube` custom resource for ActiveGate rollout

The rollout of Dynatrace ActiveGate is governed by a custom resource of type `DynaKube`. This custom resource will contain parameters for various Dynatrace capabilities (API monitoring, routing, etc.)
The rollout of Dynatrace ActiveGate is governed by a custom resource of type `DynaKube`. This custom resource will
contain parameters for various Dynatrace capabilities (API monitoring, routing, etc.)

Note: `.spec.tokens` denotes the name of the secret holding access tokens. If not specified Dynatrace Operator searches
for a secret called like the DynaKube custom resource `.metadata.name`.

Note: `.spec.tokens` denotes the name of the secret holding access tokens. If not specified Dynatrace Operator searches for a secret called like the DynaKube custom resource `.metadata.name`.
```yaml
apiVersion: dynatrace.com/v1alpha1
kind: DynaKube
Expand All @@ -67,11 +81,15 @@ spec:
#
enabled: true
```
This is the most basic configuration for the DynaKube object. In case you want to have adjustments please have a look at [our DynaKube Custom Resource example](https://raw.githubusercontent.com/Dynatrace/dynatrace-operator/master/config/samples/cr.yaml).
Save this to cr.yaml and apply it to your cluster.
This is the most basic configuration for the DynaKube object. In case you want to have adjustments please have a look
at [our DynaKube Custom Resource example](https://raw.githubusercontent.com/Dynatrace/dynatrace-operator/master/config/samples/cr.yaml)
. Save this to cr.yaml and apply it to your cluster.
```sh
$ kubectl apply -f cr.yaml
```

</details>
<details><summary>Uninstall</summary>

Expand All @@ -97,9 +115,12 @@ $ oc adm new-project --node-selector="" dynatrace
$ oc apply -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/openshift.yaml
```

A secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront.
Create access tokens of type *Dynatrace API* and *Platform as a Service* and use its values in the following commands respectively.
For assistance please refere to [Create user-generated access tokens](https://www.dynatrace.com/support/help/get-started/introduction/why-do-i-need-an-access-token-and-an-environment-id/#create-user-generated-access-tokens).
A secret holding tokens for authenticating to the Dynatrace cluster needs to be created upfront. Create access tokens of
type *Dynatrace API* and *Platform as a Service* and use its values in the following commands respectively. For
assistance please refere
to [Create user-generated access tokens](https://www.dynatrace.com/support/help/get-started/introduction/why-do-i-need-an-access-token-and-an-environment-id/#create-user-generated-access-tokens)
.

```sh
$ oc -n dynatrace create secret generic dynakube --from-literal="apiToken=DYNATRACE_API_TOKEN" --from-literal="paasToken=PLATFORM_AS_A_SERVICE_TOKEN"
```
Expand All @@ -108,7 +129,9 @@ $ oc -n dynatrace create secret generic dynakube --from-literal="apiToken=DYNATR

The rollout of Dynatrace ActiveGate is governed by a custom resource of type `DynaKube`.

Note: `.spec.tokens` denotes the name of the secret holding access tokens. If not specified Dynatrace Operator searches for a secret called like the DynaKube custom resource `.metadata.name`.
Note: `.spec.tokens` denotes the name of the secret holding access tokens. If not specified Dynatrace Operator searches
for a secret called like the DynaKube custom resource `.metadata.name`.

```yaml
apiVersion: dynatrace.com/v1alpha1
kind: DynaKube
Expand All @@ -134,11 +157,15 @@ spec:
#
enabled: true
```
This is the most basic configuration for the DynaKube object. In case you want to have adjustments please have a look at [our DynaKube Custom Resource example](https://raw.githubusercontent.com/Dynatrace/dynatrace-operator/master/config/samples/cr.yaml).
Save this to cr.yaml and apply it to your cluster.
This is the most basic configuration for the DynaKube object. In case you want to have adjustments please have a look
at [our DynaKube Custom Resource example](https://raw.githubusercontent.com/Dynatrace/dynatrace-operator/master/config/samples/cr.yaml)
. Save this to cr.yaml and apply it to your cluster.
```sh
$ oc apply -f cr.yaml
```

</details>
<details><summary>Uninstall</summary>

Expand All @@ -150,19 +177,17 @@ Remove DynaKube custom resources and clean-up all remaining Dynatrace Operator s
$ oc delete -n dynatrace dynakube --all
$ oc delete -f https://github.com/Dynatrace/dynatrace-operator/releases/latest/download/openshift.yaml
```
</details>

</details>

## Hacking

See [HACKING](HACKING.md) for details on how to get started enhancing Dynatrace Operator.


## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting changes.


## License

Dynatrace Operator is under Apache 2.0 license. See [LICENSE](LICENSE) for details.

0 comments on commit b256d83

Please sign in to comment.