add docs for loki deployment, especially for separate mode #680

mizeng · 2019-06-18T11:08:40Z

My feedback for #643.
Hope could help new beginners to understand how to deploy loki in separate mode.

docs/loki-deployment.md

mizeng · 2019-06-21T00:48:00Z

any more comments?

mizeng · 2019-06-24T09:04:56Z

why the CI failed on building k3s..

steven-sheehy · 2019-07-07T03:03:23Z

@mizeng The k3s error is fixed in master. You can just merge from master and it should resolve it.

mizeng · 2019-07-08T16:23:31Z

@steven-sheehy merged from master and still failed

steven-sheehy · 2019-07-10T14:45:56Z

But a different error ;) Any ideas @Kuqd @slim-bean ?

sh0rez

Hi! This looks nice.

Some minor nits around readability and grammar.

sh0rez · 2019-08-16T13:37:24Z

docs/loki-deployment.md

@@ -0,0 +1,160 @@
+# Overview
+This page lists the 2 common Loki deployments, to help user to better understand Loki architecture.


Suggested change

This page lists the 2 common Loki deployments, to help user to better understand Loki architecture.

This page lists the 2 common Loki deployments, to help users better understand the Loki architecture.

sh0rez · 2019-08-16T13:39:36Z

docs/loki-deployment.md

+# Overview
+This page lists the 2 common Loki deployments, to help user to better understand Loki architecture.
+
+Loki consists several components as below (Quote from slides [here](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/)):


Suggested change

Loki consists several components as below (Quote from slides [here](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/)):

Loki consists several components as below (taken from [those slides](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/)):

sh0rez · 2019-08-16T13:40:39Z

docs/loki-deployment.md

+
+
+# Loki Deployment on Single Process
+To those who want to just have a try at Loki, deploying Loki on `Single Process` is the easiest way.


Single Process Loki is not just for trying it out.

You can definitely run Loki in this mode in production and even horizontally scale it, just all components at once.

This might even be the easier approach to get it running in production

sh0rez · 2019-08-16T13:41:17Z

docs/loki-deployment.md

+To those who want to just have a try at Loki, deploying Loki on `Single Process` is the easiest way.
+It combines all above component in a single process.
+
+[Run Locally Using Docker](https://github.com/grafana/loki/tree/master/production#run-locally-using-docker) and [Run from Source](https://github.com/grafana/loki/tree/master/production#build-and-run-from-source) have already gave the examples.


Suggested change

[Run Locally Using Docker](https://github.com/grafana/loki/tree/master/production#run-locally-using-docker) and [Run from Source](https://github.com/grafana/loki/tree/master/production#build-and-run-from-source) have already gave the examples.

Refer to [Run Locally Using Docker](https://github.com/grafana/loki/tree/master/production#run-locally-using-docker) and [Run from Source](https://github.com/grafana/loki/tree/master/production#build-and-run-from-source) for examples.

sh0rez · 2019-08-16T13:41:32Z

docs/loki-deployment.md

+
+# Loki Deployment on Single Process
+To those who want to just have a try at Loki, deploying Loki on `Single Process` is the easiest way.
+It combines all above component in a single process.


Suggested change

It combines all above component in a single process.

It combines all of the above components in a single process.

sh0rez · 2019-08-16T13:48:08Z

docs/loki-deployment.md

+2. The Storage:
+
+    You need to think about using some index store and chunk store which can access from all above components.
+    For example, if you start above components in Kubernetes Pods, you may choose Amazon DynamoDB+S3, or choose boltdb+filesystem in a NFS storage like CephFS.


Suggested change

For example, if you start above components in Kubernetes Pods, you may choose Amazon DynamoDB+S3, or choose boltdb+filesystem in a NFS storage like CephFS.

For example, if you run on AWS, you may choose Amazon DynamoDB+S3, or if using Ceph/Rook boltdb+filesystem might be a good choice.

sh0rez · 2019-08-16T13:52:37Z

docs/loki-deployment.md

+3. The http_listen_port and grpc_listen_port:
+
+    If you start above components separately in different Kubernetes Pod or in different VM/BM, you don't need to worry about it.
+    If you start above components separately in your dev machine or one VM/BM, you need assign different port to them. Otherwise you will see errors like "address already in use".


Suggested change

If you start above components separately in your dev machine or one VM/BM, you need assign different port to them. Otherwise you will see errors like "address already in use".

sh0rez · 2019-08-16T13:53:23Z

docs/loki-deployment.md

+    For example, if you start above components in Kubernetes Pods, you may choose Amazon DynamoDB+S3, or choose boltdb+filesystem in a NFS storage like CephFS.
+3. The http_listen_port and grpc_listen_port:
+
+    If you start above components separately in different Kubernetes Pod or in different VM/BM, you don't need to worry about it.


Suggested change

If you start above components separately in different Kubernetes Pod or in different VM/BM, you don't need to worry about it.

If each of those components has its own IP address, you don't need to worry about it. Otherwise, you might see errors like `address already in use`.

sh0rez · 2019-08-16T13:53:57Z

docs/loki-deployment.md

+    If you start above components separately in your dev machine or one VM/BM, you need assign different port to them. Otherwise you will see errors like "address already in use".
+4. The startup command args
+
+    You need to specify the target for different component. 


Suggested change

You need to specify the target for different component.

You need to select which component to run.

sh0rez · 2019-08-16T13:54:14Z

docs/loki-deployment.md

+4. The startup command args
+
+    You need to specify the target for different component. 
+    For example, to start up Ingester only, using command like `./loki -config.file=/etc/loki/local-config.yaml -target=ingester`


Suggested change

For example, to start up Ingester only, using command like `./loki -config.file=/etc/loki/local-config.yaml -target=ingester`

For example, to start the Ingester only, use a command like `./loki -config.file=/etc/loki/local-config.yaml -target=ingester`

asmito · 2019-09-12T15:54:35Z

please is it necessary to create a consul cluster ???

otherwise what if we have created a kubernetes service for each component deployment controller with a clusterip type ?
and connect them using svc.cluster.local urls this will help us loadbalance between pods of each component

asmito · 2019-09-12T16:25:00Z

@mizeng could you please share with me the whole configuration ? if it's possible ?

sh0rez · 2019-09-17T20:04:29Z

@mizeng could you please share with me the whole configuration ? if it's possible ?

Hi! For most up to date full configuration, please refer to our ksonnet configuration: https://github.com/grafana/loki/tree/master/production/ksonnet

If you prefer not to generate the .yaml yourself, I generated it a while ago and posted it here: #643 (comment). This however does not include consul, etc. Ksonnet does.

benjaminhuo · 2019-09-21T15:49:30Z

@sh0rez It's mentioned in this link that ksonnet was archived and will not be maintained anymore.
So are you sure loki's production deployment with seperate mode still use ksonnet?
Maybe kustomize is a better option?

Thanks
Ben

sh0rez · 2019-09-22T12:15:38Z

@benjaminhuo

@sh0rez It's mentioned in this link that ksonnet was archived and will not be maintained anymore.
So are you sure loki's production deployment with seperate mode still use ksonnet?

Yes, I am aware of ksonnet being deprecated, which is the reason Grafana built a replacement solution called Tanka, which can be used as a drop-in replacement: https://github.com/grafana/tanka.

So yes, while it is named ksonnet, it will stay our state-of-the-art config for Loki!

cyriltovena · 2019-09-22T12:40:36Z

Also as soon as we get rid of Consul we will proposed a helm version that you can scale. Work in progress!

benjaminhuo · 2019-09-23T02:24:27Z

@sh0rez , glad to hear that! So Tanka is fork/variant of ksonnet and will get long-term maintenance from grafana?

@cyriltovena , cannot wait to see the scalable helm version :)

sh0rez · 2019-09-23T04:55:56Z

Yes! Tanka is a rewrite from scratch, meant to replace ksonnet internally for us and for everyone else who might need it!

benjaminhuo · 2019-09-23T05:59:37Z

Yes! Tanka is a rewrite from scratch, meant to replace ksonnet internally for us and for everyone else who might need it!

Great！

analytically · 2019-09-24T14:04:44Z

docs/loki-deployment.md

+
+Below is the sample Loki Config for Separate Mode, please pay attention to the `ingester.lifecycler.ring.kvstore` part.
+```yaml
+uth_enabled: false


mizeng · 2019-10-10T05:02:41Z

close this one since there's a better doc commit merged.

till · 2020-01-19T16:42:25Z

@mizeng your doc helped me tremendously and I wish you would re-open the PR.

I think I disagree that a couple jsonnet files are a good substitute for documentation. Especially since it's yet another layer of things to learn or dig through in order to understand how to run the components individually. :)

sh0rez reviewed Jun 18, 2019

View reviewed changes

docs/loki-deployment.md Outdated Show resolved Hide resolved

sh0rez reviewed Jun 18, 2019

View reviewed changes

docs/loki-deployment.md Outdated Show resolved Hide resolved

sh0rez reviewed Jun 18, 2019

View reviewed changes

docs/loki-deployment.md Show resolved Hide resolved

mizeng force-pushed the master branch 2 times, most recently from e6343ef to ede06bc Compare June 20, 2019 08:49

add docs for loki deployment, especially for separate mode

7df6c9a

mizeng force-pushed the master branch from ede06bc to 7df6c9a Compare July 8, 2019 16:17

slim-bean approved these changes Aug 16, 2019

View reviewed changes

sh0rez requested changes Aug 16, 2019

View reviewed changes

rfratto added the component/docs label Sep 3, 2019

sh0rez mentioned this pull request Sep 22, 2019

doc(production): replace ksonnet with Tanka #1039

Merged

analytically reviewed Sep 24, 2019

View reviewed changes

mizeng closed this Oct 10, 2019

senior88oqz mentioned this pull request Mar 12, 2020

Loki clustered deployment configuration #1768

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add docs for loki deployment, especially for separate mode #680

add docs for loki deployment, especially for separate mode #680

mizeng commented Jun 18, 2019 •

edited

Loading

mizeng commented Jun 21, 2019

mizeng commented Jun 24, 2019

steven-sheehy commented Jul 7, 2019

mizeng commented Jul 8, 2019

steven-sheehy commented Jul 10, 2019

sh0rez left a comment

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

sh0rez Aug 16, 2019

asmito commented Sep 12, 2019

asmito commented Sep 12, 2019

sh0rez commented Sep 17, 2019

benjaminhuo commented Sep 21, 2019 •

edited

Loading

sh0rez commented Sep 22, 2019

cyriltovena commented Sep 22, 2019

benjaminhuo commented Sep 23, 2019

sh0rez commented Sep 23, 2019

benjaminhuo commented Sep 23, 2019

analytically Sep 24, 2019

mizeng commented Oct 10, 2019

till commented Jan 19, 2020

		@@ -0,0 +1,160 @@
		# Overview
		This page lists the 2 common Loki deployments, to help user to better understand Loki architecture.

	Loki consists several components as below (Quote from slides [here](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/)):
	Loki consists several components as below (taken from [those slides](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/)):



		# Loki Deployment on Single Process
		To those who want to just have a try at Loki, deploying Loki on `Single Process` is the easiest way.

	[Run Locally Using Docker](https://github.com/grafana/loki/tree/master/production#run-locally-using-docker) and [Run from Source](https://github.com/grafana/loki/tree/master/production#build-and-run-from-source) have already gave the examples.
	Refer to [Run Locally Using Docker](https://github.com/grafana/loki/tree/master/production#run-locally-using-docker) and [Run from Source](https://github.com/grafana/loki/tree/master/production#build-and-run-from-source) for examples.

	It combines all above component in a single process.
	It combines all of the above components in a single process.

	For example, if you start above components in Kubernetes Pods, you may choose Amazon DynamoDB+S3, or choose boltdb+filesystem in a NFS storage like CephFS.
	For example, if you run on AWS, you may choose Amazon DynamoDB+S3, or if using Ceph/Rook boltdb+filesystem might be a good choice.

	If you start above components separately in different Kubernetes Pod or in different VM/BM, you don't need to worry about it.
	If each of those components has its own IP address, you don't need to worry about it. Otherwise, you might see errors like `address already in use`.

	You need to specify the target for different component.
	You need to select which component to run.

	For example, to start up Ingester only, using command like `./loki -config.file=/etc/loki/local-config.yaml -target=ingester`
	For example, to start the Ingester only, use a command like `./loki -config.file=/etc/loki/local-config.yaml -target=ingester`

add docs for loki deployment, especially for separate mode #680

add docs for loki deployment, especially for separate mode #680

Conversation

mizeng commented Jun 18, 2019 • edited Loading

mizeng commented Jun 21, 2019

mizeng commented Jun 24, 2019

steven-sheehy commented Jul 7, 2019

mizeng commented Jul 8, 2019

steven-sheehy commented Jul 10, 2019

sh0rez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asmito commented Sep 12, 2019

asmito commented Sep 12, 2019

sh0rez commented Sep 17, 2019

benjaminhuo commented Sep 21, 2019 • edited Loading

sh0rez commented Sep 22, 2019

cyriltovena commented Sep 22, 2019

benjaminhuo commented Sep 23, 2019

sh0rez commented Sep 23, 2019

benjaminhuo commented Sep 23, 2019

Choose a reason for hiding this comment

mizeng commented Oct 10, 2019

till commented Jan 19, 2020

mizeng commented Jun 18, 2019 •

edited

Loading

benjaminhuo commented Sep 21, 2019 •

edited

Loading