Skip to content

Commit 29eb800

Browse files
committed
clean up index.md and fix some img links
1 parent b473c34 commit 29eb800

File tree

2 files changed

+4
-91
lines changed

2 files changed

+4
-91
lines changed

userdocs/src/index.md

Lines changed: 0 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -4,90 +4,3 @@ title: eksctl - The official CLI for Amazon EKS
44
---
55

66
eksctl - The official CLI for Amazon EKS
7-
8-
`eksctl` is a simple CLI tool for creating and managing clusters on EKS - Amazon's managed Kubernetes service for EC2.
9-
It is written in Go, uses CloudFormation, was created by [Weaveworks](https://www.weave.works/) and it welcomes
10-
contributions from the community.
11-
12-
!!! example "Create a basic cluster in minutes with just one command"
13-
```
14-
eksctl create cluster
15-
```
16-
![eksctl create cluster](img/eksctl-gopher.png){ align=right width=25% }
17-
18-
A cluster will be created with default parameters:
19-
20-
- exciting auto-generated name, e.g., `fabulous-mushroom-1527688624`
21-
- two `m5.large` worker nodes (this instance type suits most common use-cases, and is good value for money)
22-
- use the official AWS [EKS AMI](https://github.com/awslabs/amazon-eks-ami)
23-
- `us-west-2` region
24-
- a dedicated VPC (check your quotas)
25-
26-
Example output:
27-
28-
```
29-
$ eksctl create cluster
30-
[ℹ] using region us-west-2
31-
[ℹ] setting availability zones to [us-west-2a us-west-2c us-west-2b]
32-
[ℹ] subnets for us-west-2a - public:192.168.0.0/19 private:192.168.96.0/19
33-
[ℹ] subnets for us-west-2c - public:192.168.32.0/19 private:192.168.128.0/19
34-
[ℹ] subnets for us-west-2b - public:192.168.64.0/19 private:192.168.160.0/19
35-
[ℹ] nodegroup "ng-98b3b83a" will use "ami-05ecac759c81e0b0c" [AmazonLinux2/1.11]
36-
[ℹ] creating EKS cluster "floral-unicorn-1540567338" in "us-west-2" region
37-
[ℹ] will create 2 separate CloudFormation stacks for cluster itself and the initial nodegroup
38-
[ℹ] if you encounter any issues, check CloudFormation console or try 'eksctl utils describe-stacks --region=us-west-2 --cluster=floral-unicorn-1540567338'
39-
[ℹ] 2 sequential tasks: { create cluster control plane "floral-unicorn-1540567338", create nodegroup "ng-98b3b83a" }
40-
[ℹ] building cluster stack "eksctl-floral-unicorn-1540567338-cluster"
41-
[ℹ] deploying stack "eksctl-floral-unicorn-1540567338-cluster"
42-
[ℹ] building nodegroup stack "eksctl-floral-unicorn-1540567338-nodegroup-ng-98b3b83a"
43-
[ℹ] --nodes-min=2 was set automatically for nodegroup ng-98b3b83a
44-
[ℹ] --nodes-max=2 was set automatically for nodegroup ng-98b3b83a
45-
[ℹ] deploying stack "eksctl-floral-unicorn-1540567338-nodegroup-ng-98b3b83a"
46-
[✔] all EKS cluster resource for "floral-unicorn-1540567338" had been created
47-
[✔] saved kubeconfig as "~/.kube/config"
48-
[ℹ] adding role "arn:aws:iam::376248598259:role/eksctl-ridiculous-sculpture-15547-NodeInstanceRole-1F3IHNVD03Z74" to auth ConfigMap
49-
[ℹ] nodegroup "ng-98b3b83a" has 1 node(s)
50-
[ℹ] node "ip-192-168-64-220.us-west-2.compute.internal" is not ready
51-
[ℹ] waiting for at least 2 node(s) to become ready in "ng-98b3b83a"
52-
[ℹ] nodegroup "ng-98b3b83a" has 2 node(s)
53-
[ℹ] node "ip-192-168-64-220.us-west-2.compute.internal" is ready
54-
[ℹ] node "ip-192-168-8-135.us-west-2.compute.internal" is ready
55-
[ℹ] kubectl command should work with "~/.kube/config", try 'kubectl get nodes'
56-
[✔] EKS cluster "floral-unicorn-1540567338" in "us-west-2" region is ready
57-
```
58-
59-
Customize your cluster by using a config file. Just run
60-
61-
```
62-
eksctl create cluster -f cluster.yaml
63-
```
64-
65-
to apply a `cluster.yaml` file:
66-
67-
```yaml
68-
apiVersion: eksctl.io/v1alpha5
69-
kind: ClusterConfig
70-
71-
metadata:
72-
name: basic-cluster
73-
region: eu-north-1
74-
75-
nodeGroups:
76-
- name: ng-1
77-
instanceType: m5.large
78-
desiredCapacity: 10
79-
- name: ng-2
80-
instanceType: m5.xlarge
81-
desiredCapacity: 2
82-
```
83-
84-
Once you have created a cluster, you will find that cluster credentials were added in `~/.kube/config`. If you have
85-
`kubectl` v1.10.x as well as `aws-iam-authenticator` commands in your PATH, you should be
86-
able to use `kubectl`. You will need to make sure to use the same AWS API credentials for this also. Check
87-
[EKS docs][ekskubectl] for instructions. If you installed `eksctl` via Homebrew, you should have all of these
88-
dependencies installed already.
89-
90-
To learn more about how to create clusters and other features continue reading the
91-
[Creating and Managing Clusters section](usage/creating-and-managing-clusters).
92-
93-
[ekskubectl]: https://docs.aws.amazon.com/eks/latest/userguide/configure-kubectl.html

userdocs/theme/home.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ <h1 id="create-cluster-in-minutes">Create a basic cluster in minutes with just o
547547
</header>
548548
<div class="mdx-spotlight">
549549
<figure class="mdx-spotlight__feature">
550-
<a href="getting-started/" tabindex="-1" title="Getting started"> <img src="../img/cluster-demo.png" alt="Getting started" loading="lazy" width="500" height="327"> </a>
550+
<a href="getting-started/" tabindex="-1" title="Getting started"> <img src="img/cluster-demo.png" alt="Getting started" loading="lazy" width="500" height="327"> </a>
551551
<figcaption class="md-typeset"> <h2><code>eksctl create cluster</code></h2>
552552
<p>A cluster will be created with default parameters:</p>
553553
<ul>
@@ -683,9 +683,9 @@ <h1 id="eksctl-adopters"> Trusted in the industry <a href="#eksctl-adopters" cla
683683
</div>
684684
</div>-->
685685
<div class="md-typeset">
686-
<p>sponsored by <a href="https://www.weave.works/"><img alt="Weaveworks" src="../img/empty.svg#wwinline"></a>
687-
and built by <a href="https://github.com/eksctl-io/eksctl/graphs/contributors"><img alt="Contributors" src="../img/gophers.png#inline"></a>
688-
on <a href="https://github.com/eksctl-io/eksctl"><img alt="Github" src="../img/empty.svg#gitinline"></a>
686+
<p>sponsored by <a href="https://www.weave.works/"><img alt="Weaveworks" src="img/empty.svg#wwinline"></a>
687+
and built by <a href="https://github.com/eksctl-io/eksctl/graphs/contributors">contributors <img alt="Contributors" src="img/gophers.png#inline"></a>
688+
on <a href="https://github.com/eksctl-io/eksctl"><img alt="Github" src="img/empty.svg#gitinline"></a>
689689
</p>
690690
<p>
691691
Site powered by <a href="https://netlify.com">Netlify &copy;</a>

0 commit comments

Comments
 (0)