summaryrefslogtreecommitdiff
path: root/icons/README.md
blob: 87f31d5ca012416b73d05e17183acd0313c85c53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# Kubernetes Icons Set

These icons are a way to standardize Kubernetes architecture diagrams for presentation. Having uniform architecture diagrams improve understandibility.

## Tools

```shell
./tools/update-everything.sh
```

This script generates png from svg, and Visio Stencil from png.

### Generate png icons from svg

```shell
./tools/rasterize.sh
```

This script will convert all svg into png. It's based on a docker container defined [here](hack/svgconvertor/Dockefile)

### Generate Visio Stencil from png icons

```shell
./tools/update-visio.sh
```

This script will convert png icons into Visio stencil using project from [here](https://github.com/hoveytechllc/visio-stencil-creator)

A Docker image hosted on GCR (`k8s.gcr.io/visio-stencil-creator`), is used to generate the Visio stencil file. The script [./tools/build-visio-stencil-creator.sh](./tools/build-visio-stencil-creator.sh) can be used to update the Docker image if it needs to be built.

## How to use these icons

Each icon can be found in differents formats
* [png](png)
* [svg](svg)

There is 2 types of icons

| Kind  | Type       | Icon                             |
|-------|------------|----------------------------------|
|  Pod  | Labeled    | ![](./png/resources/labeled/pod-128.png)       |
|  Pod  | Unlabeled  | ![](./png/resources/unlabeled/pod-128.png)     |


## Control Plane Components icons
![](./png/control_plane_components/labeled/api-128.png)
![](./png/control_plane_components/labeled/c-c-m-128.png)
![](./png/control_plane_components/labeled/c-m-128.png)
![](./png/control_plane_components/labeled/k-proxy-128.png)
![](./png/control_plane_components/labeled/kubelet-128.png)
![](./png/control_plane_components/labeled/sched-128.png)

## Infrastructure Components icons
![](./png/infrastructure_components/labeled/control-plane-128.png)
![](./png/infrastructure_components/labeled/node-128.png)
![](./png/infrastructure_components/labeled/etcd-128.png)

## Kubernetes Resources icons
![](./png/resources/labeled/c-role-128.png)
![](./png/resources/labeled/cm-128.png)
![](./png/resources/labeled/crb-128.png)
![](./png/resources/labeled/crd-128.png)
![](./png/resources/labeled/cronjob-128.png)
![](./png/resources/labeled/deploy-128.png)
![](./png/resources/labeled/ds-128.png)
![](./png/resources/labeled/ep-128.png)
![](./png/resources/labeled/group-128.png)
![](./png/resources/labeled/hpa-128.png)
![](./png/resources/labeled/ing-128.png)
![](./png/resources/labeled/job-128.png)
![](./png/resources/labeled/limits-128.png)
![](./png/resources/labeled/netpol-128.png)
![](./png/resources/labeled/ns-128.png)
![](./png/resources/labeled/pod-128.png)
![](./png/resources/labeled/psp-128.png)
![](./png/resources/labeled/pv-128.png)
![](./png/resources/labeled/pvc-128.png)
![](./png/resources/labeled/quota-128.png)
![](./png/resources/labeled/rb-128.png)
![](./png/resources/labeled/role-128.png)
![](./png/resources/labeled/rs-128.png)
![](./png/resources/labeled/sa-128.png)
![](./png/resources/labeled/sc-128.png)
![](./png/resources/labeled/secret-128.png)
![](./png/resources/labeled/sts-128.png)
![](./png/resources/labeled/svc-128.png)
![](./png/resources/labeled/user-128.png)
![](./png/resources/labeled/vol-128.png)

## Usage Example

#### Exposed Pod with 3 replicas
![](./docs/k8s-exposed-pod.png)

### Slide Deck

[Kubernetes_Icons_GSlide](https://docs.google.com/presentation/d/15h_MHjR2fzXIiGZniUdHok_FP07u1L8MAX5cN1r0j4U/edit)

## License
The Kubernetes Icons Set is licensed under a choice of either Apache-2.0
or CC-BY-4.0 (Creative Commons Attribution 4.0 International). The
Kubernetes logo is a registered trademark of The Linux Foundation, and use
of it as a trademark is subject to The Linux Foundation's Trademark Usage
Guidelines at https://www.linuxfoundation.org/trademark-usage/.