Getting Started and Other Docs #527

geoffcline · 2021-07-22T20:24:26Z

Issue, if available: N/A

Description of changes:

paths to review:

website/content/en/docs/getting-started/_index.md

do not review paths:

docs/*

I respectfully submit that housing the HTML here makes PRs very confusing. Additionally, this code only works on local previews, not GH pages.

Screenshots

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

akestner · 2021-07-22T21:29:59Z

To get ahead of potential rabbit holes, I'm working on the hosting side of things now and will surface a PR with a recommendation

njtran

Nice work! Just a couple of nits and possible suggestions.

njtran · 2021-07-22T21:29:57Z

docs/404.html

@@ -3,36 +3,36 @@
  <head>
    <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-<meta name="generator" content="Hugo 0.85.0" /><META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
+<meta name="generator" content="Hugo 0.84.1" /><META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">


Is this referring to a version of Hugo? Is there a reason we wouldn't want to use the most recent version (seems like 0.86.0

this is mooted by #528 build on netlify

docs/docs/getting-started/eks-config.yaml

website/content/en/docs/dev-guide.md

website/content/en/docs/faq.md

website/content/en/docs/getting-started/_index.md

njtran · 2021-07-22T21:39:51Z

website/content/en/docs/getting-started/_index.md

+Use helm to deploy Karpenter to the cluster. 
+
+We created a Kubernetes service account when we created the cluster using
+eksctl. Thus, we don't need the helm chart to do that.


Great. WDYT about having a command here (or a link to a command) to patch the serviceAccount for BYOC experiences or debugging purposes?

i agree but i think that's out of scope for the PR right now.

website/content/en/docs/getting-started/_index.md

njtran · 2021-07-22T21:44:17Z

website/content/en/docs/getting-started/_index.md

+
+### Create Workload
+
+This deployment uses the [pause image](https://www.ianlewis.org/en/almighty-pause-container) and starts with zero replicas. 


We also have the feature to include a karpenter.sh/do-not-evict:true annotation for pods they don't want to evict. This is a pretty specific feature, so it may overcomplicate this guide. WDYT?

i'll include that in the annotations section

website/content/en/docs/getting-started/_index.md

website/content/en/docs/getting-started/eks-config.yaml

akestner

Great work! I think this is definitely on the right track and a huge improvement over the current in-repo docs. Let's keep pushing on these to get them completed and hopefully we can get this published before the Bug Bash tomorrow.

website/content/en/docs/_index.md

website/content/en/docs/dev-guide.md

website/content/en/docs/faq.md

akestner · 2021-07-22T23:18:28Z

website/content/en/docs/faq.md

+Yes. The Kubernetes Eviction API will not delete pods that violate a [Pod Disruption Budget (PDB)](https://kubernetes.io/docs/tasks/run-application/configure-pdb/). It also disallows eviction of any pod covered by multiple PDBs, so most users will want to avoid overlapping selectors. See [this](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/#pod-disruption-budgets) for more.
+### Does Karpenter support scale to zero?
+Yes. Provisioners start at zero and launch or terminate nodes as necessary. We recommend that customers maintain a small amount of static capacity to bootstrap system controllers or run Karpenter outside of their cluster.
+## Compatibility


Let's bump this section up since these are more common questions than some of the more prominently placed ones.

moved ### Does Karpenter support scale to zero? to under ## General

I was referring to the ## Compatibility section, not scale to zero

moved compatibility to the section after general.

website/content/en/docs/faq.md

website/content/en/search.md

website/package-lock.json

akestner · 2021-07-22T23:25:56Z

website/public/404.html

@@ -0,0 +1,128 @@
+<!doctype html>


I think we should consider removing the build generated files under public/ as well as those built under ../docs/ since they cause a ton of noise in these PRs. Thoughts?

Even if we decide to keep these built files in the PR, there's no reason we'd need to have both these in public/ and those in ../docs/

i have removed website/public

we will remove ../docs/ in the netlify pr (or a follow up)

Co-authored-by: Alex Kestner <akestner@users.noreply.github.com>

akestner · 2021-07-23T05:53:04Z

Hey @geoffcline, it looks like you've force pushed to this branch a few times since it was reviewed. Is there something that you're having trouble with?

Force pushing to branches that have been shared publicly is generally frowned upon because it rewrites the git repo's history, making it difficult to understand what changes have been made and when. Back in the day, I kept this printed out next to my desk for when I got into sticky situations.

Let me know if I can help, we can touch base tomorrow as needed.

geoffcline · 2021-07-23T15:13:50Z

I was doing further development and forgot that those changes were showing up here.

Kubernetes website instructs users to force push with each new commit on a PR (they want 1 commit for each PR), so it's a bit of a learning curve for a different project.

akestner · 2021-07-23T17:02:03Z

Ahh I see, glad to hear all's well. We're getting close here, giving this another look now

website/content/en/docs/faqs.md

akestner

I think we're really close, couple minor suggestions and I think we'll be good to go!

website/content/en/docs/_index.md

website/content/en/docs/provisioner-crd.md

Co-authored-by: Alex Kestner <akestner@users.noreply.github.com>

akestner · 2021-07-23T17:52:06Z

Ship it!

…fied by default (aws#527)

geoffcline added 10 commits July 22, 2021 19:44

fix last

5d53fa4

build site

90cfcc4

rebuild site without base url

fcec4b2

add provisioner crd page

72cac48

rearrange sidebar of docs

5966e03

remove fargate from get started guide

0805c37

fixup

b41f2e7

fixup

7a07777

get working with local server

03ea3cf

built website

340c14c

geoffcline changed the title ~~Preview web~~ [WIP] getting started and other docs Jul 22, 2021

fixup

e093f70

njtran reviewed Jul 22, 2021

View reviewed changes

akestner requested changes Jul 22, 2021

View reviewed changes

akestner changed the title ~~[WIP] getting started and other docs~~ [WIP] Getting Started and Other Docs Jul 22, 2021

geoffcline force-pushed the preview-web branch from f6f2a4a to e093f70 Compare July 23, 2021 02:17

geoffcline and others added 3 commits July 22, 2021 21:19

Apply suggestions from code review

754674a

Co-authored-by: Alex Kestner <akestner@users.noreply.github.com>

update filenames and get started guide

6f9b02f

remove html

d68df27

geoffcline force-pushed the preview-web branch from 0b48016 to d68df27 Compare July 23, 2021 02:24

geoffcline added 5 commits July 23, 2021 02:32

remove search.md

8731470

revise based on changes from ellis in other pr

23a7d42

fix link to prov crd

854a013

bump prov crd api version to v1alpha3

4cc1f75

pesky newline eks-config.yaml

ef45aa4

geoffcline force-pushed the preview-web branch 2 times, most recently from 2c2ee65 to ef45aa4 Compare July 23, 2021 02:49

geoffcline marked this pull request as ready for review July 23, 2021 02:50

geoffcline changed the title ~~[WIP] Getting Started and Other Docs~~ Getting Started and Other Docs Jul 23, 2021

geoffcline force-pushed the preview-web branch from d9becf9 to ef45aa4 Compare July 23, 2021 05:10

geoffcline commented Jul 23, 2021

View reviewed changes

website/content/en/docs/faqs.md Outdated Show resolved Hide resolved

remove merge text

1af3866

geoffcline force-pushed the preview-web branch from a78fab0 to 5318958 Compare July 23, 2021 17:20

reset docs/ folder to main branch

d5d226d

geoffcline force-pushed the preview-web branch from 5318958 to d5d226d Compare July 23, 2021 17:26

geoffcline added 2 commits July 23, 2021 17:28

remove images

407c9d3

move up compatability section of faq

e2ab26d

akestner requested changes Jul 23, 2021

View reviewed changes

website/content/en/docs/_index.md Show resolved Hide resolved

website/content/en/docs/provisioner-crd.md Outdated Show resolved Hide resolved

Apply suggestions from code review

d8e3d19

Co-authored-by: Alex Kestner <akestner@users.noreply.github.com>

akestner self-requested a review July 23, 2021 17:51

akestner approved these changes Jul 23, 2021

View reviewed changes

geoffcline merged commit 05abd58 into aws:main Jul 23, 2021

gfcroft pushed a commit to gfcroft/karpenter-provider-aws that referenced this pull request Nov 25, 2023

test: Don't constrain the NodeClaim if no test requirements are speci…

7b431d5

…fied by default (aws#527)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Getting Started and Other Docs #527

Getting Started and Other Docs #527

geoffcline commented Jul 22, 2021 •

edited by akestner

akestner commented Jul 22, 2021

njtran left a comment

njtran Jul 22, 2021

geoffcline Jul 23, 2021

njtran Jul 22, 2021

geoffcline Jul 23, 2021

njtran Jul 22, 2021

geoffcline Jul 23, 2021

akestner left a comment

akestner Jul 22, 2021

geoffcline Jul 23, 2021

akestner Jul 23, 2021

geoffcline Jul 23, 2021

geoffcline Jul 23, 2021

akestner Jul 22, 2021

geoffcline Jul 23, 2021

akestner commented Jul 23, 2021

geoffcline commented Jul 23, 2021

akestner commented Jul 23, 2021

akestner left a comment

akestner commented Jul 23, 2021


		### Create Workload

		This deployment uses the [pause image](https://www.ianlewis.org/en/almighty-pause-container) and starts with zero replicas.

Getting Started and Other Docs #527

Getting Started and Other Docs #527

Conversation

geoffcline commented Jul 22, 2021 • edited by akestner

akestner commented Jul 22, 2021

njtran 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

akestner 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

akestner commented Jul 23, 2021

geoffcline commented Jul 23, 2021

akestner commented Jul 23, 2021

akestner left a comment

Choose a reason for hiding this comment

akestner commented Jul 23, 2021

geoffcline commented Jul 22, 2021 •

edited by akestner