Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Call out performance-optimized k8s config #3827

Merged
merged 1 commit into from
Oct 5, 2018
Merged

Conversation

jseldess
Copy link
Contributor

@jseldess jseldess commented Oct 4, 2018

Fixes #3823.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Contributor

@a-robinson a-robinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 4 of 4 files at r1.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


_includes/v2.0/orchestration/start-cluster.md, line 22 at r1 (raw file):

~~~

Alternatively, if you'd rather start with a configuration file that has been tweaked for performance, use our [performance version of `cockroachdb-statefulset-secure.yaml`](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml):

It's worth noting that there are some parameters in the file that may justify tweaking. A more reasonable workflow is to download it (curl or wget), modify it based on the the lines marked TODO, and then kubectl create -f using the locally modified file.

Most notably, even if their cluster has enough cpu/memory for the high performance config, users may not have defined the SSD disk type as called out in the file - https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml#L294


v2.0/kubernetes-performance.md, line 24 at r1 (raw file):

In a number of the sections below, we have shown how to modify excerpts from our provided Kubernetes configuration YAML files. You can find the most up-to-date versions of these files on Github, [one for running CockroachDB in secure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset-secure.yaml) and one for [running CockroachDB in insecure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset.yaml).

You can also use a [configuration file for secure mode that has been tweaked for performance](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml).

I'd also include a note here about how it may require some customization.

Copy link
Contributor Author

@jseldess jseldess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


_includes/v2.0/orchestration/start-cluster.md, line 22 at r1 (raw file):

Previously, a-robinson (Alex Robinson) wrote…

It's worth noting that there are some parameters in the file that may justify tweaking. A more reasonable workflow is to download it (curl or wget), modify it based on the the lines marked TODO, and then kubectl create -f using the locally modified file.

Most notably, even if their cluster has enough cpu/memory for the high performance config, users may not have defined the SSD disk type as called out in the file - https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml#L294

Done.


v2.0/kubernetes-performance.md, line 24 at r1 (raw file):

Previously, a-robinson (Alex Robinson) wrote…

I'd also include a note here about how it may require some customization.

Done.

@jseldess
Copy link
Contributor Author

jseldess commented Oct 5, 2018

Look ok now, @a-robinson?

Copy link
Contributor

@a-robinson a-robinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm: other than the wget question

Reviewed 4 of 4 files at r2.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (and 1 stale)


_includes/v2.0/orchestration/start-cluster.md, line 28 at r2 (raw file):

    {% include copy-clipboard.html %}
    ~~~ shell
    $ wget https://raw.githubusercontent.com/cockroachdb/cockroach/master/cloud/kubernetes/performance/cockroachdb-statefulset-secure.yaml \

For what it's worth, wget isn't on mac by default. Or at least it isn't on my mac. Do we use it over curl elsewhere in the docs?

@jseldess
Copy link
Contributor Author

jseldess commented Oct 5, 2018


_includes/v2.0/orchestration/start-cluster.md, line 28 at r2 (raw file):

Previously, a-robinson (Alex Robinson) wrote…

For what it's worth, wget isn't on mac by default. Or at least it isn't on my mac. Do we use it over curl elsewhere in the docs?

Good catch. We're pretty inconsistent in the docs. Sometimes we give a mac/linux toggle. I'll just use curl here in the hope that most users are on mac.

@jseldess jseldess merged commit cd203cd into master Oct 5, 2018
@jseldess jseldess deleted the k8s-performance-config branch October 5, 2018 16:10
@rkruze
Copy link
Contributor

rkruze commented Oct 5, 2018

It seems we only call out the more performant deployment file when running secure? Should we have some mention in the inse​cure area, as that seems to be what most people do when running a POC.

@jseldess
Copy link
Contributor Author

jseldess commented Oct 5, 2018

Good point, @rkruze. Unfortunately, we only have a secure performant config. It'd probably be confusing to reference that in an insecure deployment. If we can create an insecure performant config, I can include it in the same way.

@a-robinson
Copy link
Contributor

@rkruze if an insecure version would be useful, I can certainly add one.

@rkruze
Copy link
Contributor

rkruze commented Oct 5, 2018 via email

craig bot pushed a commit to cockroachdb/cockroach that referenced this pull request Oct 8, 2018
31015: kubernetes: Add insecure version of high-performance statefulset config r=a-robinson a=a-robinson

Release note: None

cc @rkruze @jseldess cockroachdb/docs#3827 (comment)

Co-authored-by: Alex Robinson <alexdwanerobinson@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants