Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
gaetancollaud committed Feb 5, 2024
1 parent b107a6f commit 25c46c5
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 13 deletions.
4 changes: 0 additions & 4 deletions docs/architecture/src/07_deployment_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,3 @@ actor "User"
....


=== Installation

Please follow the installation instructions from the link:../installation/[installation folder].

1 change: 1 addition & 0 deletions docs/installation/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// configure EN settings for asciidoc

[[section-installation]]
== Installation

<<<
Expand Down
10 changes: 5 additions & 5 deletions docs/installation/src/02_kafka_setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ Kafka cost control uses internal topic to compute pricing. You will have to crea

==== Reference AVRO schemas

Some schemas will reference link:../../aggregator/src/main/avro/entity-type-enum.avsc[EntityType]. Please add it to your schema registry and reference it when needed.
Some schemas will reference link:https://github.com/spoud/kafka-cost-control/tree/master/aggregator/src/main/avro/entity-type-enum.avsc[EntityType]. Please add it to your schema registry and reference it when needed.

==== Topics

[cols="1,1,1,1"]
|===
| Topic name | Clean up policy | Key| Value

| context-data | compact | _String_ | link:../../aggregator/src/main/avro/context-data.avsc[ContextData]
| context-data | compact | _String_ | link:https://github.com/spoud/kafka-cost-control/tree/master/aggregator/src/main/avro/context-data.avsc[ContextData]

| pricing-rule | compact | _String_ | link:../../aggregator/src/main/avro/pricing-rule.avsc[PricingRule]
| pricing-rule | compact | _String_ | link:https://github.com/spoud/kafka-cost-control/tree/master/aggregator/src/main/avro/pricing-rule.avsc[PricingRule]

| aggregated | delete | link:../../aggregator/src/main/avro/aggregated-data-key.avsc[AggregatedDataKey] | link:../../aggregator/src/main/avro/aggregated-data-windowed.avsc[AggregatedDataWindowed]
| aggregated | delete | link:https://github.com/spoud/kafka-cost-control/tree/master/aggregator/src/main/avro/aggregated-data-key.avsc[AggregatedDataKey] | link:https://github.com/spoud/kafka-cost-control/tree/master/aggregator/src/main/avro/aggregated-data-windowed.avsc[AggregatedDataWindowed]

| aggregated-table-friendly
| delete | link:../../aggregator/src/main/avro/aggregated-data-key.avsc[AggregatedDataKey] | link:../../aggregator/src/main/avro/aggregated-data-table-friendly.avsc[AggregatedDataTableFriendly]
| delete | link:https://github.com/spoud/kafka-cost-control/tree/master/aggregator/src/main/avro/aggregated-data-key.avsc[AggregatedDataKey] | link:https://github.com/spoud/kafka-cost-control/tree/master/aggregator/src/main/avro/aggregated-data-table-friendly.avsc[AggregatedDataTableFriendly]

| metrics-raw-telegraf-dev | delete | _None_ | _String_

Expand Down
6 changes: 3 additions & 3 deletions docs/installation/src/03_kubernetes.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=== Kubernetes

You can find all the deployment files in the link:../../deployment[deployment] folder. This folder use link:https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/[Kustomize] to simplify the deployment of multiple instances with some variations.
You can find all the deployment files in the link:https://github.com/spoud/kafka-cost-control/tree/master/deployment[deployment] folder. This folder use link:https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/[Kustomize] to simplify the deployment of multiple instances with some variations.

==== Create namespace

Expand All @@ -26,7 +26,7 @@ vi .env
----
Edit the environment file with the correct output topic, endpoints and credentials.

Be sure to edit the *namespace* in the link:../../deployment/kafka-metric-scrapper/dev/kustomization.yaml[kustomization.yaml] file.
Be sure to edit the *namespace* in the link:https://github.com/spoud/kafka-cost-control/tree/master/deployment/kafka-metric-scrapper/dev/kustomization.yaml[kustomization.yaml] file.

Deploy the dev environment using kubectl

Expand Down Expand Up @@ -54,7 +54,7 @@ vi .env
----
Edit the environment file with the correct credentials. The database password can be randomly generated. It will be used by kafka connect and grafana.

Be sure to edit the *namespace* in the link:../../deployment/kafka-cost-control/dev/kustomization.yaml[kustomization.yaml] file.
Be sure to edit the *namespace* in the link:https://github.com/spoud/kafka-cost-control/tree/master/deployment/kafka-cost-control/dev/kustomization.yaml[kustomization.yaml] file.

You also may want to adapt the ingress files to use a proper hosts. You will need two hosts, one for grafana and one for the kafka cost control application.

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/src/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=== Introduction

This user manual will help you understand kafka Cost Control and how to use it propertly. This document assumes that you already have a running application. If not please see the link:../installation/[installation documentation].
This user manual will help you understand kafka Cost Control and how to use it propertly. This document assumes that you already have a running application. If not please see the <<section-installation>> section.

At this point you should have access to the Kafka Cost Control UI and to the Grafana Dashboard.

Expand Down

0 comments on commit 25c46c5

Please sign in to comment.