Spektate

This is an initiative to visualize Project Bedrock. Spektate ties in information from the repositories API, the pipelines API and information stored in an Azure Table to display the dashboard with the following components:

Here's a detailed diagram describing the Spektate workflow. Each pipeline is responsible for sending a unique set of data to the storage, which is used to connect all the pieces together:

Currently, Spektate consists of a command line interface and a simple dashboard prototype. The instructions to use both are below.

Note: Spektate dashboard will delete deployments when their corresponding builds/releases have expired in Azure DevOps.

Official docker images for this dashboard are located at mcr.microsoft.com/k8s/bedrock/spektate.

Onboard a Bedrock project to use Spektate

Follow the steps in this guide to onboard a project to use Spektate.

Install on your cluster

The helm chart to use this dashboard is located here. There's a Load Balancer provided in the helm chart but it's turned off in values.yaml with the setting externalIP. Set this to true if you would like to expose the dashboard via a public endpoint.

Substitute values for your configuration and install this dashboard via the command below:

cd ./chart
helm install . --name spektate --set storageAccessKey=<storageAccessKey> --set storageTableName=<storageTableName> --set storagePartitionKey=<storagePartitionKey> --set storageAccountName=<storageAccountName> --set pipelineProject=<pipelineProjectName> --set pipelineOrg=<pipelineOrg> --set pipelineAccessToken=<PipelinePAT> --set manifest=<manifestRepoName> --set manifestAccessToken=<manifestAccessToken> --set githubManifestUsername=<gitHubUserName>  --set sourceRepoAccessToken=<sourceRepoAccessToken>

• storageAccessKey: Access key for the storage account
• storageTableName: Table name for the storage account
• storagePartitionKey: Partition key for your configuration, you may want to use project name or some identifier that helps separate unrelated configurations for the purpose of introspection.
• storageAccountName: Storage account name
• pipelineProject: Project name for the pipelines in Azure DevOps
• pipelineOrg: Org name for the pipelines in Azure DevOps
• pipelineAccessToken: Access token for pipelines in Azure DevOps
• manifestRepoName: Manifest repository name
• manifestAccessToken: Access token for the manifest repository
• sourceRepoAccessToken: Access token for the source repository
• Note: If you're using GitHub, add githubManifestUsername: Account name or organization name under which the manifest repository resides.

If you're not using an external IP, use port-forwarding to access the dashboard:

1. Copy pod name from kubectl get pods
2. kubectl port-forward pod/<pod-name> 2200:5000 or change 2200 to a port of your choice
3. Navigate to http://localhost:2200 or change 2200 to a port of your choice

Dashboard dev mode

1. Clone this repository.

2. There is frontend and backend folders and each of them are separate yarn projects. cd frontend in one window and cd backend in another.

3. Add the following env variables to your shell where you have changed directory to backend:

   export REACT_APP_STORAGE_ACCESS_KEY=
   export REACT_APP_STORAGE_TABLE_NAME=
   export REACT_APP_STORAGE_PARTITION_KEY=
   export REACT_APP_STORAGE_ACCOUNT_NAME=
   export REACT_APP_PIPELINE_PROJECT=
   export REACT_APP_PIPELINE_ORG=
   export REACT_APP_PIPELINE_ACCESS_TOKEN=
   export REACT_APP_MANIFEST=
   export REACT_APP_MANIFEST_ACCESS_TOKEN=
   export REACT_APP_SOURCE_REPO_ACCESS_TOKEN=

   • REACT_APP_STORAGE_ACCESS_KEY: Access key for the storage account
   • REACT_APP_STORAGE_TABLE_NAME: Table name for the storage account
   • REACT_APP_STORAGE_PARTITION_KEY: Partition key for your configuration, you may want to use project name or some identifier that helps separate unrelated configurations for the purpose of introspection.
   • REACT_APP_STORAGE_ACCOUNT_NAME: Storage account name
   • REACT_APP_PIPELINE_PROJECT: Project name for the pipelines in Azure DevOps
   • REACT_APP_PIPELINE_ORG: Org name for the pipelines in Azure DevOps
   • REACT_APP_PIPELINE_ACCESS_TOKEN: Access token for pipelines in Azure DevOps
   • REACT_APP_MANIFEST: Manifest repository name
   • REACT_APP_MANIFEST_ACCESS_TOKEN: Access token for the manifest repository
   • REACT_APP_SOURCE_REPO_ACCESS_TOKEN: Access token for the source repository
   • Note: If you're using GitHub, add REACT_APP_GITHUB_MANIFEST_USERNAME: Account name or organization name under which the manifest repository resides.

4. Run yarn in both to install dependencies

5. Run yarn start in both to start the applications. You should be able to see the dashboard launch in one, and a Node.js server start in another! It should navigate you to the browser where dashboard is running.

Publish Docker image

In order to publish images to this repository, you will need access to devcrewsacr.azurecr.io

1. Run az acr login --name devcrewsacr
2. If you do not know credentials you will need to login, grab them from portal.azure.com or run az acr credential show --name devcrewsacr.
3. Run docker login devcrewsacr.azurecr.io and you will be prompted to enter the credentials
4. Run docker push devcrewsacr.azurecr.io/public/k8s/bedrock/spektate:<tag>

Azure Web App Hosting

You can provide an Azure Active Directory layer of authetication on top of Spektate. Follow instructions here.

Command Line Interface

To use the CLI for Spektate, head over to https://github.com/microsoft/bedrock-cli.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.