linkerd-buoyant
![GitHub license](https://img.shields.io/github/license/buoyantio/linkerd-buoyant.svg)
The Linkerd Buoyant extension connects your
Linkerd-enabled Kubernetes cluster to
Buoyant Cloud, the global platform health dashboard for
Linkerd.
This repo consists of two components:
agent
: Runs on your Kubernetes cluster.
cli
: Runs locally or wherever you install the Linkerd CLI.
Install CLI
To install the CLI, run:
curl -sL https://buoyant.cloud/install | sh
Alternatively, you can download the CLI directly via the
releases page.
Usage
$ linkerd-buoyant
linkerd-buoyant manages the Buoyant Cloud agent.
It enables operational control over the Buoyant Cloud agent, providing install,
upgrade, and delete functionality.
Usage:
linkerd-buoyant [command]
Available Commands:
check Check the Buoyant Cloud agent installation for potential problems
completion Generate the autocompletion script for the specified shell
dashboard Open the Buoyant Cloud dashboard
help Help about any command
install Output Buoyant Cloud agent manifest for installation
uninstall Output Kubernetes manifest to uninstall the Buoyant Cloud agent
version Print the CLI and agent version information
Flags:
--context string The name of the kubeconfig context to use
-h, --help help for linkerd-buoyant
--kubeconfig string Path to the kubeconfig file to use for CLI requests (default "/home/sig/.kube/config")
-v, --verbose Turn on debug logging
Use "linkerd-buoyant [command] --help" for more information about a command.
Development
Agent
Setup credentials and env vars
export BUOYANT_CLOUD_CLIENT_ID="org-client-id"
export BUOYANT_CLOUD_CLIENT_SECRET="org-client-secret"
export AGENT_NAME="agent-name"
Build and run agent registrator
# Create agent-metadata config map with the desired agent name
cat <<EOF | kubectl apply -f -
kind: Namespace
apiVersion: v1
metadata:
name: buoyant-cloud
annotations:
linkerd.io/inject: enabled
labels:
app.kubernetes.io/part-of: buoyant-cloud
linkerd.io/extension: buoyant
---
kind: ConfigMap
metadata:
name: agent-metadata
namespace: buoyant-cloud
labels:
app.kubernetes.io/part-of: buoyant-cloud
apiVersion: v1
data:
agent_name: $AGENT_NAME
EOF
# Run the registrator
bin/go-run agent registrator
Build and run agent
# Read the agent id field (populated by the registrator) in the agent-metadata config map
export AGENT_ID=$(kubectl get cm/agent-metadata -n buoyant-cloud -o jsonpath='{.data.agent_id}')
# Run the agent with the agent id
bin/go-run agent agent --agent-id=$AGENT_ID
Docker build:
docker buildx build -f agent/Dockerfile -t ghcr.io/buoyantio/linkerd-buoyant:latest .
CLI
Build and run:
bin/go-run cli
Run with a version number:
go run -ldflags "-s -w -X github.com/buoyantio/linkerd-buoyant/cli/pkg/version.Version=vX.Y.Z" cli/main.go version
Test against a local server:
bin/go-run cli --bcloud-server http://localhost:8084 check
Protobuf
The generated protobuf bindings in gen
come from the proto
directory in this
repo. If you make changes there, re-generate them with:
bin/gen-proto
Testing
go test -race -cover ./...
bin/lint
Helm
Test template:
helm template --namespace buoyant-cloud --values charts/linkerd-buoyant/ci/fake-values.yaml linkerd-buoyant charts/linkerd-buoyant
Install:
helm install --create-namespace --namespace buoyant-cloud --values charts/linkerd-buoyant/ci/fake-values.yaml linkerd-buoyant charts/linkerd-buoyant
To install a live agent from buoyant.cloud you need to obtain its
values.yml
. To obtain a values file, head over to
https://buoyant.cloud/settings?helm=1. In case you have only one pair
of org credentials, you will be prompted with a dialog that contains
the helm values. Otherwise, you can pick the exact credentials pair and
click on Helm usage. Save the values into agent-values.yaml
.
helm install --create-namespace --namespace buoyant-cloud --values agent-values.yaml --set metadata.agentName=$AGENT_NAME linkerd-buoyant charts/linkerd-buoyant
Update chart README.md:
bin/helm-docs --chart-search-root=charts
Release
Note the latest release:
https://github.com/BuoyantIO/linkerd-buoyant/releases
TAG=v0.0.XX
git tag $TAG
git push origin $TAG
License
Copyright 2022 Buoyant, Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
these files except in compliance with the License. You may obtain a copy of the
License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.