Skip to content

Commit a1e08c1

Browse files
author
Neil Jerram
authored
Merge pull request #1029 from neiljerram/note-regularization
Regularize our indented NOTE box format
2 parents 148ee80 + dfeca52 commit a1e08c1

File tree

31 files changed

+222
-167
lines changed

31 files changed

+222
-167
lines changed

master/getting-started/docker/tutorials/security-using-calico-profiles.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ To create the networks, run the following commands on one of the hosts:
3737
docker network create --driver calico --ipam-driver calico-ipam net2
3838
docker network create --driver calico --ipam-driver calico-ipam net3
3939

40-
>Note: To allocate from a specific Calico IP Pool, the `--subnet a.b.c.d/xx` command can be passed to `docker network create`. For more details see below.
40+
> **NOTE**
41+
>
42+
> To allocate from a specific Calico IP Pool, the `--subnet a.b.c.d/xx` command can be passed to `docker network create`. For more details see below.
4143
4244
## 2. Create the workloads in the networks
4345

master/getting-started/kubernetes/installation/hosted/kubernetes-datastore/index.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ You must have a cluster which meets the following requirements:
2626
- Your Kubernetes controller manager is configured to allocate pod CIDRs (i.e. by passing `--allocate-node-cidrs=true` to the controller manager)
2727
- Your Kubernetes controller manager has been provided a cluster-cidr (i.e. by passing `--cluster-cidr=192.168.0.0/16`, which the manifest expects by default).
2828

29-
> Note: If you are upgrading from Calico v2.1, the cluster-cidr selected for your controller manager should remain
29+
> **NOTE**
30+
>
31+
> If you are upgrading from Calico v2.1, the cluster-cidr selected for your controller manager should remain
3032
> unchanged from the v2.1 install (the v2.1 manifests default to `10.244.0.0/16`).
3133
3234
## Installation
@@ -39,7 +41,9 @@ This document describes three installation options for Calico using Kubernetes A
3941

4042
Ensure you have a cluster which meets the above requirements. There may be additional requirements based on the installation option you choose.
4143

42-
> Note: There is currently no upgrade path to switch between different installation options. Therefore,
44+
> **NOTE**
45+
>
46+
> There is currently no upgrade path to switch between different installation options. Therefore,
4347
> if you are upgrading from Calico v2.1, use the [Calico policy-only with user-supplied networking](#2-calico-policy-only-with-user-supplied-networking) installation instructions
4448
> to upgrade Calico policy-only which leaves the networking solution unchanged.
4549
@@ -50,7 +54,9 @@ RBAC roles to allow API access to Calico.
5054

5155
Apply the following manifest to create these necessary RBAC roles and bindings.
5256

53-
> Note: The following RBAC policy is compatible with the Kubernetes v1.7+ manifests only.
57+
> **NOTE**
58+
>
59+
> The following RBAC policy is compatible with the Kubernetes v1.7+ manifests only.
5460
5561
```
5662
kubectl apply -f {{site.url}}/{{page.version}}/getting-started/kubernetes/installation/hosted/rbac-kdd.yaml
@@ -66,7 +72,9 @@ networking with a full node-to-node mesh and/or explicit configuration of peers.
6672
To install Calico with Calico networking, run one of the commands below based on your Kubernetes version.
6773
This will install Calico and will initially create a full node-to-node mesh.
6874

69-
> Note: Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
75+
> **NOTE**
76+
>
77+
> Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
7078
7179
```
7280
kubectl apply -f {{site.url}}/{{page.version}}/getting-started/kubernetes/installation/hosted/kubernetes-datastore/calico-networking/1.7/calico.yaml
@@ -99,7 +107,9 @@ CIDR allocations, either through static routes, a Kubernetes cloud-provider inte
99107

100108
To install Calico in policy-only mode, run one of the following commands based on your Kubernetes version:
101109

102-
> Note: Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
110+
> **NOTE**
111+
>
112+
> Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
103113
104114
```
105115
kubectl apply -f {{site.url}}/{{page.version}}/getting-started/kubernetes/installation/hosted/kubernetes-datastore/policy-only/1.7/calico.yaml

master/getting-started/kubernetes/installation/integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ installation method.
2020
- Calico can share the etcd cluster used by Kubernetes, but in some cases it's recommended that a separate cluster is set up.
2121
A number of production users do share the etcd cluster between the two, but separating them gives better performance at high scale.
2222

23-
> **NOTE:**
23+
> **NOTE**
2424
>
2525
> Calico can also be installed [without a dependency on etcd](hosted/kubernetes-datastore/), but that is not covered in this document.
2626
@@ -104,7 +104,7 @@ WantedBy=multi-user.target
104104
```
105105
> Replace `<ETCD_IP>:<ETCD_PORT>` with your etcd configuration.
106106
107-
> **NOTE:**
107+
> **NOTE**
108108
>
109109
> To ensure reasonable dataplane programming latency on a system under load,
110110
`calico/node` requires a CPU reservation of at least 0.25 cores with additional

master/getting-started/kubernetes/installation/vagrant/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ Run
2424

2525
vagrant up
2626

27-
> *Note*: This will deploy a Kubernetes master and two Kubernetes nodes. To run more nodes, modify the value `num_instances` in the Vagrantfile before running `vagrant up`.
27+
> **NOTE**
28+
>
29+
> This will deploy a Kubernetes master and two Kubernetes nodes. To run more nodes, modify the value `num_instances` in the Vagrantfile before running `vagrant up`.
2830
2931
To connect to your servers
3032

master/getting-started/kubernetes/tutorials/advanced-policy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ kubectl expose --namespace=advanced-policy-demo deployment nginx --port=80
5555

5656
#### Check using calicoctl
5757

58-
> **Note:**
58+
> **NOTE**
5959
>
6060
> This requires the [calicoctl tool to be configured]({{site.baseurl}}/{{page.version}}/reference/calicoctl/setup/etcdv2).
6161
> For example: `export ETCD_ENDPOINTS=http://10.96.232.136:6666`
@@ -70,7 +70,7 @@ $ calicoctl get profile -o wide
7070
NAME TAGS
7171
k8s_ns.advanced-policy-demo k8s_ns.advanced-policy-demo
7272
k8s_ns.default k8s_ns.default
73-
k8s_ns.kube-public k8s_ns.kube-public
73+
k8s_ns.kube-public k8s_ns.kube-public
7474
k8s_ns.kube-system k8s_ns.kube-system
7575
```
7676

@@ -157,7 +157,7 @@ It now shows up as a [Policy]({{site.baseurl}}/{{page.version}}/reference/calico
157157
$ calicoctl get policy -o wide
158158
NAME ORDER SELECTOR
159159
advanced-policy-demo.access-nginx 1000 calico/k8s_ns == 'advanced-policy-demo' && run == 'nginx'
160-
advanced-policy-demo.default-deny 1000 calico/k8s_ns == 'advanced-policy-demo'
160+
advanced-policy-demo.default-deny 1000 calico/k8s_ns == 'advanced-policy-demo'
161161
```
162162

163163
After creating the policy, we can now access the nginx Service. We also see that the pod can

master/getting-started/kubernetes/tutorials/using-calicoctl.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@ machine with access to your etcd cluster by setting `ETCD_ENDPOINTS`. For exampl
1616
ETCD_ENDPOINTS=http://etcd:2379 calicoctl get profile
1717
```
1818

19-
>**Note for kubeadm deployments**
19+
> **NOTE for kubeadm deployments**
2020
>
2121
> Calico is not configured to use the etcd run by kubeadm on the Kubernetes master.
2222
> Instead, it launches its own instance of etcd as a pod, available at
23-
`http://10.96.232.136:6666`.
24-
>Ensure you are connecting to the correct etcd or you will not see any of the expected data.
23+
> `http://10.96.232.136:6666`.
24+
> Ensure you are connecting to the correct etcd or you will not see any of the expected data.
2525
2626
### b. Running calicoctl as a Kubernetes Pod
2727

2828
The `calico/ctl` docker image can be deployed as a pod and used to run calicoctl
2929
commands. This pod will need to be configured for the Kubernetes environment it is in.
3030

31-
>**Note**
31+
> **NOTE**
3232
>
33-
>When calicoctl is run as a Pod, the `calicoctl node ...` suite of commands is not available.
33+
> When calicoctl is run as a Pod, the `calicoctl node ...` suite of commands is not available.
3434
3535

3636
For the **etcd backend** (e.g. kubeadm):

master/getting-started/kubernetes/upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ spec:
199199
podSelector:
200200
```
201201
202-
> **Note**:
202+
> **NOTE**
203203
>
204204
> The above steps should be followed when upgrading to Calico v2.3.0+ using the Kubernetes
205205
> datastore driver, and Calico v2.4.0+ using the etcd datastore,

master/getting-started/mesos/installation/dc-os/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ be restarted to pick up the change. The Framework then performs the following st
108108
}
109109
}
110110
```
111-
>Note: If not running etcd in proxy mode, be sure to change `etcd_endpoints`
111+
> **NOTE**
112+
>
113+
> If not running etcd in proxy mode, be sure to change `etcd_endpoints`
112114
to your correct etcd endpoint address.
113115

114116
4. Restart the slave process with `systemctl restart dcos-mesos-slave`

master/getting-started/mesos/installation/integration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ Calico runs as a Docker container on each host. The `calicoctl` command line too
2323
sudo ETCD_ENDPOINTS=http://$ETCD_IP:$ETCD_PORT calicoctl node run --node-image=quay.io/calico/node:{{site.data.versions[page.version].first.title}}
2424
```
2525

26-
>Note: Ensure you've set or replaced `$ETCD_IP` and `$ETCD_PORT` to point to
26+
> **NOTE**
27+
>
28+
> Ensure you've set or replaced `$ETCD_IP` and `$ETCD_PORT` to point to
2729
[your etcd cluster](prerequisites).
2830

2931
Check that `calico/node` is now running:

master/getting-started/mesos/installation/prerequisites.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ Cluster Store: etcd://10.0.0.1:2379
5858
By default, Mesos only enables the "Mesos" Containerizer. Ensure
5959
the Docker Containerizer is also enabled on each Agent.
6060

61-
>Note: You may skip this step if you do not plan on using the Docker Containerizer.
61+
> **NOTE**
62+
>
63+
> You may skip this step if you do not plan on using the Docker Containerizer.
6264
6365
If you are using the default `mesos-init-wrapper` from the official Mesos package,
6466
you can enable the Docker Containerizer with the following command:
@@ -73,7 +75,9 @@ $ systemctl restart mesos-slave.service
7375
If you are planning to use Calico with the Unified containerizer,
7476
[enable the CNI Isolator on each agent](http://mesos.apache.org/documentation/latest/cni/#usage)
7577

76-
>Note: You may skip this step if you do not plan on using the Unified Containerizer.
78+
> **NOTE**
79+
>
80+
> You may skip this step if you do not plan on using the Unified Containerizer.
7781
7882
When enabling CNI, you will have specified a `network_cni_config_dir`
7983
and `network_cni_plugins_dir`. We'll refer to these going forward as

0 commit comments

Comments
 (0)