Skip to content

Commit

Permalink
Add plugins and ref docs in all components
Browse files Browse the repository at this point in the history
  • Loading branch information
jmichalak-fluxninja committed Mar 1, 2024
1 parent 29602e9 commit 3c5bba9
Show file tree
Hide file tree
Showing 24 changed files with 4,483 additions and 66 deletions.
2 changes: 1 addition & 1 deletion backstage.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
name: {service_name}
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/{service_name}/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
{
"devDependencies": {
"@kt3k/license-checker": "^3.2.2",
"markdown-link-check": "^3.9.3",
"markdown-toc": "^1.2.0",
"markdownlint-cli": "0.37.0",
"@kt3k/license-checker": "^3.2.2"
"markdownlint-cli": "0.37.0"
},
"dependencies": {
"@adityasinghal26/plugin-github-codespaces": "^1.0.3"
}
}
5 changes: 1 addition & 4 deletions src/accountingservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,9 @@ metadata:
name: accountingservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/accountingservice/
github.com/project-slug: jmichalak9/opentelemetry-demo
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- resource:default/kafka
4 changes: 1 addition & 3 deletions src/adservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ metadata:
name: adservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/adservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/featureflagservice
4 changes: 1 addition & 3 deletions src/cartservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ metadata:
name: cartservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/cartservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/featureflagservice
10 changes: 1 addition & 9 deletions src/checkoutservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,9 @@ metadata:
name: checkoutservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/checkoutservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/cartservice
- component:default/currencyservice
- component:default/emailservice
- component:default/paymentservice
- component:default/productcatalogservice
- component:default/shippingservice
- resource:default/kafka
2 changes: 1 addition & 1 deletion src/currencyservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: currencyservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/currencyservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
2 changes: 1 addition & 1 deletion src/emailservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: emailservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/emailservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
5 changes: 1 addition & 4 deletions src/featureflagservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,9 @@ metadata:
name: featureflagservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/featureflagservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- resource:default/ffspostgres
providesApis: [pb]
6 changes: 3 additions & 3 deletions src/ffspostgres/backstage.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

Check failure on line 1 in src/ffspostgres/backstage.yaml

View workflow job for this annotation

GitHub Actions / yamllint

1:1 [empty-lines] too many blank lines (1 > 0)
apiVersion: backstage.io/v1alpha1
kind: Resource
kind: Component
metadata:
name: ffspostgres
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/ffspostgres/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: database
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
4 changes: 1 addition & 3 deletions src/frauddetectionservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ metadata:
name: frauddetectionservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/frauddetectionservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- resource:default/kafka
9 changes: 1 addition & 8 deletions src/frontend/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,9 @@ metadata:
name: frontend
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/frontend/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/cartservice
- component:default/currencyservice
- component:default/checkoutservice
- component:default/productcatalogservice
- component:default/shippingservice
- component:default/recommendationservice
5 changes: 1 addition & 4 deletions src/frontendproxy/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,9 @@ metadata:
name: frontendproxy
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/frontendproxy/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/frontend
- component:default/featureflagservice
2 changes: 1 addition & 1 deletion src/grafana/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: grafana
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/grafana/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
6 changes: 3 additions & 3 deletions src/kafka/backstage.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

Check failure on line 1 in src/kafka/backstage.yaml

View workflow job for this annotation

GitHub Actions / yamllint

1:1 [empty-lines] too many blank lines (1 > 0)
apiVersion: backstage.io/v1alpha1
kind: Resource
kind: Component
metadata:
name: kafka
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/kafka/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: database
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
4 changes: 1 addition & 3 deletions src/loadgenerator/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ metadata:
name: loadgenerator
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/loadgenerator/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/frontendproxy
2 changes: 1 addition & 1 deletion src/otelcollector/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: otelcollector
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/otelcollector/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
2 changes: 1 addition & 1 deletion src/paymentservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: paymentservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/paymentservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
4 changes: 1 addition & 3 deletions src/productcatalogservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ metadata:
name: productcatalogservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/productcatalogservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/featureflagservice
2 changes: 1 addition & 1 deletion src/prometheus/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: prometheus
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/prometheus/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
2 changes: 1 addition & 1 deletion src/quoteservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: quoteservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/quoteservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
Expand Down
4 changes: 1 addition & 3 deletions src/recommendationservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ metadata:
name: recommendationservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://opentelemetry.io/docs/demo/services/recommendationservice/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
spec:
type: service
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/featureflagservice
3 changes: 0 additions & 3 deletions src/shippingservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,3 @@ spec:
lifecycle: production
owner: user:guest
system: opentelemetry-demo
dependsOn:
- component:default/featureflagservice
- component:default/quoteservice
Loading

0 comments on commit 3c5bba9

Please sign in to comment.