Observe@Edge Stats UI
INTERNAL USE ONLY. This is a demo proof-of-concept and not ready for production.
See it LIVE
Demo running in Staging. See the following notes for how to access and use it.
- You will need to log in with the Fastly Eng Okta. This is synced with regular Okta, so you should use the same username and password. If this doesn't work, check that you have the "Fastly-Eng Okta" chiclet on your Okta home page. If not, ask IT for access.
- Once logged in with Okta, you will be presented with another "Auth" page. Here you should put either a Fastly API token or a Signal Sciences API token (or both). Both can be generated from the respective management consoles. E.g. for Fastly, generate a new key here.
- Now you can choose a service in the dropdown to view its stats (this will differ depending on the customer you created a key for). If using the Fastly customer key, you can also paste any Service ID into the URL to view it, e.g.
https://observe-edge-ui.stg.k8s.secretcdn.net/fastly/<service_id>
This is a demo site that uses live data from Fastly and Signal Sciences APIs to demonstrate
Run yarn
from root to install project dependencies.
Run yarn start
to run a development webserver.
The devserver will by default open a browser and use port 3000
. To specify different behavior, add a .env
file to
root:
BROWSER=none
PORT=3001
To generate a production build of the demo site, run yarn build
from root.
To serve the production build, run yarn serve
.
In order to mitigate CORS, a small nodejs server is used to proxy requests to API endpoints.
This project is deployed to Kubernetes using the Elevation platform. The Helm chart is defined under charts/observe-edge-ui.
Deployments to the dev Kubernetes cluster can be done locally using kubectl
. To set this up, follow the steps
under Onboarding Process. You will also need to
be connected to the VPN.
Once logged in with oulogin
, you are now ready to deploy. Within the charts directory, run:
helm -n data-engineering upgrade -f observe-edge-ui/values.yaml -i observe-edge-ui observe-edge-ui
If successful, the changes should be viewable
at https://observe-edge-ui.int.usc1.dev.k8s.secretcdn.net/.
Again, .int.
indicates that this is an internal endpoint, and you need to be connected to the VPN to view it.
You may then use kubectl
to further inspect the deployment. Here are some useful commands:
kubectl -n data-engineering describe deployments
kubectl -n data-engineering get pods
kubectl -n data-engineering get ing
After your changes to the code are reviewed and merged to the main
branch, a pull request will automatically be raised
to elevation-data. Merge this to bump the image version and deploy to
staging.
Staging deploys are available under observe-edge-ui.stg.k8s.secretcdn.net.
- Team: Data Engineering + UI, UX Engineering
- Slack: #stats-chart-poc
- Engineer: Ben Pinkerton
- Engineer: Ali Torbati
- Engineer: John Donahue
- Engineer: Colton McCurdy
- Engineer: Herman Schaaf
- Engineer: Shawn Smith
- SRE: TODO
- Reference: TODO
- Runbook: TODO
- Shiply: https://shiply.fastly.com/fastly/observe-edge-ui
- PagerDuty: TODO
- JIRA: https://jira.corp.fastly.com/projects/DATAENG
- Jenkins: https://ci.secretcdn.net/job/team-data/job/observe-edge-ui/