-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c73e3d4
commit 053033d
Showing
2 changed files
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
id: getting-started-for-nimbus-web-integration | ||
title: Getting Started for Nimbus Web Integration | ||
slug: getting-started-for-nimbus-web-integration | ||
--- | ||
|
||
## Introduction | ||
|
||
This guide outlines the high level steps and considerations for integrating Nimbus (Cirrus) into your web application. More detailed steps are available in the [checklist](https://docs.google.com/document/d/1GyO3o81RxrfXdN0oLz__6F0S3eCPbLKx5nHmDyv5i34/copy?usp=sharing) | ||
|
||
## Prerequisites | ||
|
||
Before integrating Nimbus (Cirrus) into your web application, ensure the following prerequisites are met: | ||
- [Glean](https://docs.telemetry.mozilla.org/concepts/glean/glean.html) is integrated on your web application | ||
- [Feature Manifest Language (FML) configuration](https://experimenter.info/fml-spec#introducing-the-fml) is available in your repository | ||
- Add application into [probe scraper](https://mozilla.github.io/glean/book/user/adding-glean-to-your-project/enable-data-ingestion.html#add-your-product-to-probe-scraper) for data collection | ||
- Access to Cirrus container image: [Mozilla Cirrus Docker Hub](https://hub.docker.com/r/mozilla/cirrus/tags) | ||
|
||
## Integration Steps | ||
To integrate Nimbus (Cirrus) with your web applicatio, these are high-level steps, you can find more detailed version in the [checklist](https://docs.google.com/document/d/1GyO3o81RxrfXdN0oLz__6F0S3eCPbLKx5nHmDyv5i34/copy?usp=sharing): | ||
|
||
1. **Deploy Cirrus Container** | ||
- Deploy Cirrus container as a sidecar container in your Kubernetes deployment and add the [environment variables](https://github.com/mozilla/experimenter/tree/main/cirrus#environment-setup). | ||
|
||
2. **Configure Feature Manifest Language (FML)** | ||
- Add feature in Feature Manifest Language (FML). | ||
|
||
3. **Integrate Glean SDK** | ||
- Identify key metrics and configure with your application. | ||
|
||
4. **Call Cirrus Container** | ||
- Pass the unique client id and context when calling the container to receive the features. Refer to [API docs](https://github.com/mozilla/experimenter/tree/main/cirrus) for more details. | ||
```json | ||
{ | ||
"client_id": "4a1d71ab-29a2-4c5f-9e1d-9d9df2e6e449", | ||
"context": { | ||
"key1": "value1", | ||
"key2": { | ||
"key2.1": "value2", | ||
"key2.2": "value3" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
5. **Validation and Testing** | ||
- Validate setup and test the integration thoroughly. | ||
|
||
6. **Experiment Analysis** | ||
- Add application support on Jetstream/OpMon and Metric hub. | ||
|
||
7. **Additional Considerations** | ||
- Provide training resources for experiment owners and reviewers. | ||
|
||
## Additional Notes | ||
|
||
For any questions or assistance, reach out to the Nimbus team on Slack channel #ask-experimenter. | ||
|
||
|
||
|
||
|
||
|
||
|