Skip to content

Update 020 - webhooks-agent.md #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@ a highly available and distributed web application.

Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/full-stack/docs).

Optimizely Rollouts is free feature flags for development teams. Easily roll out and roll back features in any application without code deploys. Mitigate risk for every feature on your roadmap. Learn more at https://www.optimizely.com/rollouts/, or see the [documentation](https://docs.developers.optimizely.com/rollouts/docs).

## Getting Started
To get started with Optimizely Agent, follow the [getting started guide](./docs/getting-started.md) and view example
usage in our [examples folder](./examples).
To get started with Optimizely Agent, follow the [Quickstart guide](https://docs.developers.optimizely.com/full-stack/docs/) and view example usage in our [examples folder](./examples).

## Prerequisites
Optimizely Agent is implemented in [Golang](https://golang.org/). Golang version 1.13+ is required for developing and compiling from source.
Expand Down Expand Up @@ -275,10 +272,10 @@ go tool pprof http://localhost:6060/debug/pprof/mutex
To view all available profiles can be found at [http://localhost:8088/debug/pprof/](http://localhost:8088/debug/pprof/) in your browser.

## Authorization
Optimizely Agent supports authorization workflows based on OAuth and JWT standards, allowing you to protect access to its API and Admin interfaces. For details, see the [Authorization Guide](./docs/auth.md).
Optimizely Agent supports authorization workflows based on OAuth and JWT standards, allowing you to protect access to its API and Admin interfaces. For details, see [Authorization Guide](https://docs.developers.optimizely.com/full-stack/docs/authorization).

## Notifications
Just as you can use Notification Listeners to subscribe to events of interest with Optimizely SDKs, you can use the Notifications endpoint to subscribe to events in Agent. For more information, see the [Notifications Guide](./docs/notifications.md).
Just as you can use Notification Listeners to subscribe to events of interest with Optimizely SDKs, you can use the Notifications endpoint to subscribe to events in Agent. For more information, see the [Notifications Guide](https://docs.developers.optimizely.com/full-stack/docs/agent-notifications).

## Package Structure
Following best practice for go project layout as defined [here](https://github.com/golang-standards/project-layout)
Expand Down Expand Up @@ -353,7 +350,7 @@ License (MIT): github.com/stretchr/testify
net
(c) 2009 The Go Authors
License (BSD 3-Clause): https://github.com/golang/net

sync
(c) 2009 The Go Authors
License (BSD 3-Clause): https://github.com/golang/sync
Expand All @@ -365,7 +362,7 @@ License (Apache 2): github.com/rakyll/statik v0.1.7
sys
(c) 2009 The Go Authors
License (BSD 3-Clause): https://github.com/golang/sys

## Apache Copyright Notice
Copyright 2019-present, Optimizely, Inc. and contributors

Expand Down
115 changes: 0 additions & 115 deletions docs/auth.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Getting Started Guide

This is a brief guide showing how to run Agent locally via Docker and how to access some of the common API endpoints.
---
title: "Quickstart with Docker"
excerpt: ""
slug: "quickstart-with-docker"
hidden: true
metadata:
title: "Agent Quickstart with Docker - Optimizely Full Stack"
createdAt: "2020-05-21T20:35:58.387Z"
updatedAt: "2020-07-14T20:51:52.458Z"
---

This is a brief quickstart showing how to run Agent locally via Docker and how to access some of the common API endpoints.
If Docker is not installed then you can download it [here](https://docs.docker.com/install/).

## Running locally via Docker
Expand Down Expand Up @@ -57,4 +66,4 @@ resp = s.post(url = 'http://localhost:8080/v1/activate', params=params, json=pay
print(resp.json())
```

The activate API is a POST to signal to the caller that there are side-effects. Namely, activation results in a "decision" event sent to Optimizely analytics for the purpose of analyzing Feature Test results. A "decision" will NOT be sent if the feature is simply part of a rollout.
The activate API is a POST to signal to the caller that there are side-effects. Namely, activation results in a "decision" event sent to Optimizely analytics for the purpose of analyzing Feature Test results. A "decision" will NOT be sent if the feature is simply part of a rollout.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Set up Optimizely Agent"
title: "Install Optimizely Agent"
excerpt: ""
slug: "setup-optimizely-agent"
hidden: false
metadata:
title: "Getting started with Agent - Optimizely Full Stack"
title: "Install Agent - Optimizely Full Stack"
createdAt: "2020-02-21T17:44:27.363Z"
updatedAt: "2020-03-31T23:54:17.841Z"
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,8 @@ webhook:
# secret: <secret-10000>
# ## skipSignatureCheck: override the signature check (not recommended for production)
# skipSignatureCheck: true
```
```

## Next

[Create Webhooks](https://docs.developers.optimizely.com/full-stack/docs/webhooks-agent)
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# Notifications Guide
---
title: Agent Notifications"
excerpt: ""
slug: "agent-notifications"
hidden: false
metadata:
title: "Agent notifications - Optimizely Full Stack"
createdAt: "2020-05-21T20:35:58.387Z"
updatedAt: "2020-07-14T20:51:52.458Z"
---


Agent provides an endpoint that sends notifications to subscribers via [Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events). This is Agent's equivalent of Notification Listeners found in Optimizely SDKs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export OPTIMIZELY_CLIENT_POLLINGINTERVAL=120s
```

## Unsupported Environment Variable Options
Some options can only be set via config file, and not environment variable (for details on these options, see the Configuration Options table in the [main README](../README.md)):
Some options can only be set via config file, and not environment variable (for details on these options, see the Configuration Options table in the [main README](https://github.com/optimizely/agent/blob/master/README.md):
- `admin.auth.clients`
- `api.auth.clients`
- Options under`webhook.projects`