Skip to content

Commit

Permalink
Merge pull request #1003 from wavefrontHQ/shavi-spring-boot3-csp
Browse files Browse the repository at this point in the history 
CSP updates for Wavefront for Spring Boot
  • Loading branch information
@shavidissa
shavidissa authored Jan 22, 2024
2 parents 1467480 + e6bcad7 commit 2e828c0
Showing 1 changed file with 74 additions and 10 deletions.
84 changes: 74 additions & 10 deletions pages/doc/wavefront_spring_boot3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -243,18 +243,82 @@ dependencies {

### Step 2 (Optional): Specify Your Operations for Applications Instance

By default, the Wavefront Spring Boot Starter creates an account for you and sends data to the Freemium instance. If you already have an Operations for Applications account, you can send data there instead by specifying the `uri` and `api-token` properties as follows:
By default, the Wavefront Spring Boot Starter creates an account for you and sends data to the Freemium instance. If you already have a VMware Cloud Services account or an Operations for Applications account, you can send data there instead by specifying the properties shown below:

```
management.wavefront.api-token = $API_Token
management.wavefront.uri = $wavefront_instance
<ul id="profileTabs" class="nav nav-tabs">
<li class="active"><a href="#oauth" data-toggle="tab">Server to Server OAuth App</a></li>
<li><a href="#api" data-toggle="tab">API Token</a></li>
</ul>
<div class="tab-content">
<div role="tabpanel" class="tab-pane active" id="oauth">
<p>
Add these properties to authenticate with the ID and Secret of a Server to Server OAuth App in VMware Cloud Services:
</p>
<pre>
management.wavefront.api-token-type=CSP_CLIENT_CREDENTIALS
management.wavefront.uri={ENTER_WAVEFRONT_INSTANCE_URL}
management.wavefront.api-token=clientId={ENTER_CLIENT-ID},clientSecret={ENTER_SECRET},orgId={OPTIONAL_ORG_ID}
wavefront.freemium-account = false
```

* `$API_Token` is a valid [API token for your Operations for Applications instance](users_account_managing.html#generate-an-api-token).
* `$wavefront_instance` is the name of your Operations for Applications instance, for example, `https://example.wavefront.com`.
* Set `wavefront.freemium-account` as false. Because you have an Operations for Applications instance, you do not need a freemium account.

</pre>
<ul>
<li>
Replace <code>{ENTER_WAVEFRONT_INSTANCE_URL}</code> with the name of your Operations for Applications instance, for example, https://example.wavefront.com.
</li>
<li>
Replace <code>{ENTER_CLIENT-ID}</code> and <code>{ENTER_SECRET}</code> with the credentials (client ID and client secret) of an existing server-to-server OAuth app which has the <b>Direct Data Ingestion</b> service role assigned and is added to the VMware Cloud organization running the Operations for Applications service.
</li>
<li>
The <code>{OPTIONAL_ORG_ID}</code> parameter is optional, and you can replace it with the long ID of the VMware Cloud organization running the service.
</li>
<li>
Set <code>wavefront.freemium-account</code> as false. Because you have an Operations for Applications instance, you do not need a freemium account.
</li>
</ul>
</div>
<div role="tabpanel" class="tab-pane" id="api">
<ul>
<li>
<b>VMware Cloud Services API Token</b>:<br/>If you have a VMware Cloud Service account, add the following properties to authenticate with a VMware Cloud Services API Token.
<pre>
management.wavefront.api-token-type=CSP_API_TOKEN
management.wavefront.uri={ENTER_WAVEFRONT_INSTANCE_URL}
management.wavefront.api-token={ENTER_CSP_API_TOKEN}
wavefront.freemium-account = false
</pre>
<ul>
<li>
Replace <code>{ENTER_WAVEFRONT_INSTANCE_URL}</code> with the name of your Operations for Applications instance, for example, https://example.wavefront.com.
</li>
<li>
Replace <code>{ENTER_CSP_API_TOKEN}</code> with your VMware Cloud Services API token. The API token must be generated in the VMware Cloud Services Console by an active user account and must be assigned the <b>Direct Data Ingestion</b>service role.
</li>
<li>
Set <code>wavefront.freemium-account</code> as false. Because you have an Operations for Applications instance, you do not need a freemium account.
</li>
</ul>
</li>
<li>
<b>Operations for Applications API Token</b>: <br/>If you have an Operations for Applications account, add the following properties to authenticate with the API Token (legacy).
<pre>
management.wavefront.api-token = {ENTER_API_TOKEN}
management.wavefront.uri = {ENTER_WAVEFRONT_INSTANCE_URL}
wavefront.freemium-account = false
</pre>
<ul>
<li>
Replace <code>{ENTER_WAVEFRONT_INSTANCE_URL}</code> with the name of your Operations for Applications instance, for example, https://example.wavefront.com.
</li>
<li>
Replace <code>{WAVEFRONT_INSTANCE_URL}</code> with the name of your Operations for Applications instance, for example, https://example.wavefront.com.
</li>
<li>
Set <code>wavefront.freemium-account</code> as false. Because you have an Operations for Applications instance, you do not need a freemium account.
</li>
</ul>
</li>
</ul>
</div>
</div>

### Step 3: View Your Data in Our Service

Expand Down

0 comments on commit 2e828c0

Please sign in to comment.