ddnk-dev / apm-instrumentaion-operator Goto Github PK

Background

To get started, we need to do some project scaffolding.

Goal

• scaffolding project

Objective

• init project with kubebuilder
• generate instrumentation api with kubebuilder
• generate instrumentation webhook with kubebuilder

ETC

kubebuilder: https://book.kubebuilder.io/

Background

Need to make specification of instrumentation api

Goal

• Instrumentation API Specification

Objective

• make APi Specification document
• fill the api/v1/instrumentation_types.go with api spec

ETC

Background

It would be useful if JMX exporter injection feature were provided along with java agent injection feature

Goal

• add jmx exporter injection feature
• add default jmx exporter configs
• add customable jmx exporter config injection feature

Objective

• design jmx exporter's crd spec
• add spec document
• implement jmx exporter injection feature
• implement jmx exporter's pre-defined config injection feature
• implement jmx configmap mount feature

ETC

• jmx exporter config examples : link

Background

On github action's first run on each branch, golangci-lint fails.

Goal

• Find reason of the issue
• Fix the github actions config

Objective

• fix golangci lint workflow

ETC

Background

From opentelemetry-java-instrumentation release 2.x, they changed default protocol to http/protobuf from grpc. So port negotiation logic is needed like python instrumentation logic.

Goal

• add negotiation logic

Objective

• Add negotiation logic changing endpoint port to 4317 if image tag is not 1.x
• test negotiation

ETC

• related release : https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.0.0

Background

Release default features

Goal

• Add how-to-use and examples to readme
• release default features
• test release branch CI/CD

Objective

• test release branch CI/CD
• add how-to examples to main readmd.md
• merge release branch to main branch
• publish release note and add tag to main branch

Background

Need agent injection features... (at least two)

Goal

• make python agent injection feature

Objective

• make python crd spec
• implement python agent inejction feature
• documentation

ETC

Background

This project needs CI && Delivery pipeline

Goal

• Build a CI strategy
• Build a Image Tag strategy
• Add golang CI pipeline to project

Objective

• Build CI & Branch strategy
• Add github action building operator image
• Fix Makefile to set tag with branch name

ETC

Background

need to automate updating project's dependencies

Goal

• configure dependabot

Objective

• add dependabot & config

ETC

dependabot : github link

Background

Need to implement default mutating/validation webhook service and Java Autoinstrumentation

Goal

• Implement default webhook service
• Implement Java auto instrumentation

Objective

• Implement webhook service (mutating/validation)
• Implement Java auto instrumentation
• Generate api spec doc if needed
• test defaulter and validator
• test java auto instrumentation

ETC

feature reference: https://github.com/open-telemetry/opentelemetry-java-instrumentation