Skip to content

Commit f2f455c

Browse files
abuehrletomwilkie
authored andcommitted
updated slack channels WUOG (cortexproject#295)
* updated slack channels WUOG * add feedback welcome * punctuation * update screen captures update text to match * cropped resized monitor
1 parent 8cc8afa commit f2f455c

File tree

3 files changed

+24
-10
lines changed

3 files changed

+24
-10
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,26 @@
99

1010
Cortex is an API compatible [Prometheus](https://prometheus.io) implementation, that natively supports multitenancy and horizontal scale-out clustering.
1111

12-
Cortex is a [Weaveworks](https://weave.works) project that forms the monitoring backend of [Weave Cloud](https://cloud.weave.works). If you have any questions regarding our hosted Prometheus as a service, please contact [help@weave.works](mailto:help@weave.works).
12+
Cortex is a [Weaveworks](https://weave.works) project that forms the monitoring backend of [Weave Cloud](https://cloud.weave.works).
1313

14-
## Getting started with Weave Cloud & Kubernetes
14+
15+
## Getting Started with Weave Cloud & Kubernetes
1516

1617
Go to https://cloud.weave.works and sign up. Follow the steps to create a new instance.
1718

1819
Once you have created your instance, note down the 'Service Token' listed underneath 'Probes' in the box on the right of the screen. You will use this token to authenticate your local Prometheus with Weave Cloud.
1920

21+
<p align="center"><img src="imgs/weave-cloud-token.png" alt="Weave Cloud Token"></p>
22+
2023
Install the Cortex agent (an unmodified OSS Prometheus) on your Kubernetes cluster using the following command:
2124

2225
$ kubectl -n kube-system apply -f 'https://cloud.weave.works/k8s/cortex.yaml?t=<token>'
2326

24-
Select the Cortex service in the Weave Cloud UI:
27+
Click Monitor to access the Cortex service in the Weave Cloud UI:
2528

26-
<p align="center"><img src="imgs/cloud.png" alt="Cropped screenshot of Weave Cloud showing Prometheus button as graph"></p>
29+
<p align="center"><img src="imgs/monitor-cortex.png" alt="Prometheus Monitoring with Weave Cortex"></p>
2730

28-
Weave Cloud gives you some example queries that show you general system information. You can of course [write your own Prometheus queries](https://prometheus.io/docs/querying/basics/).
31+
Weave Cloud gives you some example queries that displays general system information. You can of course [write your own Prometheus queries](https://prometheus.io/docs/querying/basics/).
2932

3033

3134
## About Weave Cortex
@@ -37,7 +40,7 @@ To learn more about Weave Cortex, consult the follow documents / talks:
3740
- KubeCon Prometheus Day talk "Weave Cortex: Multi-tenant, horizontally scalable Prometheus as a Service" [slides](http://www.slideshare.net/weaveworks/weave-cortex-multitenant-horizontally-scalable-prometheus-as-a-service)
3841
- Or join us on [our Slack channel](https://slack.weave.works) and ask us directly!
3942

40-
## Using Cortex on other platforms
43+
## Using Cortex on Other Platforms
4144

4245
Cortex can be used to monitor virtually any application on any platform, as the local agent is a specially configured unmodified OSS Prometheus binary. You can [download Prometheus from its website](https://prometheus.io/download/). You will need v1.2.1 or later.
4346

@@ -51,10 +54,9 @@ When you've got Prometheus, you will need to [configure it to discover your serv
5154
Where `<token>` is the Service Token you obtained from Weave Cloud.
5255

5356
Once your local Prometheus is running you can enter Prometheus queries into
54-
Weave Cloud. Go to https://cloud.weave.works and click the graph icon to the
55-
right of the instance selector:
57+
Weave Cloud. Go to https://cloud.weave.works and click Monitor from Weave Cloud header:
5658

57-
<p align="center"><img src="imgs/cloud.png" alt="Cropped screenshot of Weave Cloud showing Prometheus button as graph"></p>
59+
<p align="center"><img src="imgs/monitor-cortex.png" alt="Prometheus Monitoring with Weave Cortex"></p>
5860

5961
## Using Cortex to power Grafana dashboards
6062

@@ -77,4 +79,16 @@ To build & test, install minikube, and run:
7779

7880
Cortex will sit behind an nginx instance exposed on port 30080. A job is deployed to scrape it itself. Try it:
7981

80-
http://192.168.99.100:30080/api/prom/api/v1/query?query=up
82+
http://192.168.99.100:30080/api/prom/api/v1/query?query=up
83+
84+
## <a name="help"></a>Getting Help
85+
86+
If you have any questions regarding Cortex our hosted Prometheus as a service:
87+
88+
- Invite yourself to the <a href="https://weaveworks.github.io/community-slack/" target="_blank"> #weave-community </a> slack channel.
89+
- Ask a question on the <a href="https://weave-community.slack.com/messages/general/"> #weave-community</a> slack channel.
90+
- Join the <a href="https://www.meetup.com/pro/Weave/"> Weave User Group </a> and get invited to online talks, hands-on training and meetups in your area.
91+
- Send an email to <a href="mailto:weave-users@weave.works">weave-users@weave.works</a>
92+
- <a href="https://github.com/weaveworks/cortex/issues/new">File an issue.</a>
93+
94+
Your feedback is always welcome!

imgs/monitor-cortex.png

96.4 KB
Loading

imgs/weave-cloud-token.png

130 KB
Loading

0 commit comments

Comments
 (0)