Merge pull request #1029 from neiljerram/note-regularization

Regularize our indented NOTE box format

Author: Neil Jerram

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

@@ -37,7 +37,9 @@ To create the networks, run the following commands on one of the hosts:
     docker network create --driver calico --ipam-driver calico-ipam net2
     docker network create --driver calico --ipam-driver calico-ipam net3
 
->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.
+> **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.
 
 ## 2. Create the workloads in the networks
 

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

@@ -26,7 +26,9 @@ You must have a cluster which meets the following requirements:
 - Your Kubernetes controller manager is configured to allocate pod CIDRs (i.e. by passing `--allocate-node-cidrs=true` to the controller manager)
 - 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).
 
-> Note:  If you are upgrading from Calico v2.1, the cluster-cidr selected for your controller manager should remain
+> **NOTE**
+>
+> If you are upgrading from Calico v2.1, the cluster-cidr selected for your controller manager should remain
 > unchanged from the v2.1 install (the v2.1 manifests default to `10.244.0.0/16`).
 
 ## Installation
@@ -39,7 +41,9 @@ This document describes three installation options for Calico using Kubernetes A
 
 Ensure you have a cluster which meets the above requirements.  There may be additional requirements based on the installation option you choose.
 
-> Note:  There is currently no upgrade path to switch between different installation options.  Therefore,
+> **NOTE**
+>
+> There is currently no upgrade path to switch between different installation options.  Therefore,
 > 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
 > to upgrade Calico policy-only which leaves the networking solution unchanged.
 
@@ -50,7 +54,9 @@ RBAC roles to allow API access to Calico.
 
 Apply the following manifest to create these necessary RBAC roles and bindings.
 
-> Note: The following RBAC policy is compatible with the Kubernetes v1.7+ manifests only.
+> **NOTE**
+>
+> The following RBAC policy is compatible with the Kubernetes v1.7+ manifests only.
 
 ```
 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.
 To install Calico with Calico networking, run one of the commands below based on your Kubernetes version.
 This will install Calico and will initially create a full node-to-node mesh.
 
-> Note: Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
+> **NOTE**
+>
+> Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
 
 ```
 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
 
 To install Calico in policy-only mode, run one of the following commands based on your Kubernetes version:
 
-> Note: Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
+> **NOTE**
+>
+> Calico `v2.5.0` or higher with Kubernetes backend requires Kubernetes `v1.7.0` or higher.
 
 ```
 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

@@ -20,7 +20,7 @@ installation method.
   - Calico can share the etcd cluster used by Kubernetes, but in some cases it's recommended that a separate cluster is set up.
     A number of production users do share the etcd cluster between the two, but separating them gives better performance at high scale.
 
-> **NOTE:**
+> **NOTE**
 >
 > Calico can also be installed [without a dependency on etcd](hosted/kubernetes-datastore/), but that is not covered in this document.
 
@@ -104,7 +104,7 @@ WantedBy=multi-user.target
 ```
 > Replace `<ETCD_IP>:<ETCD_PORT>` with your etcd configuration.
 
-> **NOTE:**
+> **NOTE**
 >
 > To ensure reasonable dataplane programming latency on a system under load,
 `calico/node` requires a CPU reservation of at least 0.25 cores with additional

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

@@ -24,7 +24,9 @@ Run
 
     vagrant up
 
-> *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`.
+> **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`.
 
 To connect to your servers
 

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

@@ -55,7 +55,7 @@ kubectl expose --namespace=advanced-policy-demo deployment nginx --port=80
 
 #### Check using calicoctl
 
-  > **Note:**
+  > **NOTE**
   >
   > This requires the [calicoctl tool to be configured]({{site.baseurl}}/{{page.version}}/reference/calicoctl/setup/etcdv2).
   > For example: `export ETCD_ENDPOINTS=http://10.96.232.136:6666`
@@ -70,7 +70,7 @@ $ calicoctl get profile -o wide
 NAME                          TAGS
 k8s_ns.advanced-policy-demo   k8s_ns.advanced-policy-demo
 k8s_ns.default                k8s_ns.default
-k8s_ns.kube-public            k8s_ns.kube-public 
+k8s_ns.kube-public            k8s_ns.kube-public
 k8s_ns.kube-system            k8s_ns.kube-system
 ```
 
@@ -157,7 +157,7 @@ It now shows up as a [Policy]({{site.baseurl}}/{{page.version}}/reference/calico
 $ calicoctl get policy -o wide
 NAME                                ORDER   SELECTOR
 advanced-policy-demo.access-nginx   1000    calico/k8s_ns == 'advanced-policy-demo' && run == 'nginx'
-advanced-policy-demo.default-deny   1000    calico/k8s_ns == 'advanced-policy-demo' 
+advanced-policy-demo.default-deny   1000    calico/k8s_ns == 'advanced-policy-demo'
 ```
 
 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

@@ -16,21 +16,21 @@ machine with access to your etcd cluster by setting `ETCD_ENDPOINTS`. For exampl
 ETCD_ENDPOINTS=http://etcd:2379 calicoctl get profile
 ```
 
->**Note for kubeadm deployments**
+> **NOTE for kubeadm deployments**
 >
 > Calico is not configured to use the etcd run by kubeadm on the Kubernetes master.
 > Instead, it launches its own instance of etcd as a pod, available at
-`http://10.96.232.136:6666`.
->Ensure you are connecting to the correct etcd or you will not see any of the expected data.
+> `http://10.96.232.136:6666`.
+> Ensure you are connecting to the correct etcd or you will not see any of the expected data.
 
 ### b. Running calicoctl as a Kubernetes Pod
 
 The `calico/ctl` docker image can be deployed as a pod and used to run calicoctl
 commands. This pod will need to be configured for the Kubernetes environment it is in.
 
->**Note**
+> **NOTE**
 >
->When calicoctl is run as a Pod, the `calicoctl node ...` suite of commands is not available.
+> When calicoctl is run as a Pod, the `calicoctl node ...` suite of commands is not available.
 
 
 For the **etcd backend** (e.g. kubeadm):

master/getting-started/kubernetes/upgrade.md

@@ -199,7 +199,7 @@ spec:
   podSelector:
 ```
 
-> **Note**:
+> **NOTE**
 >
 > The above steps should be followed when upgrading to Calico v2.3.0+ using the Kubernetes
 > datastore driver, and Calico v2.4.0+ using the etcd datastore,

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

@@ -108,7 +108,9 @@ be restarted to pick up the change. The Framework then performs the following st
        }
    }
    ```
-   >Note: If not running etcd in proxy mode, be sure to change `etcd_endpoints`
+   > **NOTE**
+   >
+   > If not running etcd in proxy mode, be sure to change `etcd_endpoints`
    to your correct etcd endpoint address.
 
 4. Restart the slave process with `systemctl restart dcos-mesos-slave`

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

@@ -23,7 +23,9 @@ Calico runs as a Docker container on each host. The `calicoctl` command line too
    sudo ETCD_ENDPOINTS=http://$ETCD_IP:$ETCD_PORT calicoctl node run --node-image=quay.io/calico/node:{{site.data.versions[page.version].first.title}}
    ```
 
-   >Note: Ensure you've set or replaced `$ETCD_IP` and `$ETCD_PORT` to point to
+   > **NOTE**
+   >
+   > Ensure you've set or replaced `$ETCD_IP` and `$ETCD_PORT` to point to
    [your etcd cluster](prerequisites).
 
    Check that `calico/node` is now running:

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

@@ -58,7 +58,9 @@ Cluster Store: etcd://10.0.0.1:2379
 By default, Mesos only enables the "Mesos" Containerizer. Ensure
 the Docker Containerizer is also enabled on each Agent.
 
->Note: You may skip this step if you do not plan on using the Docker Containerizer.
+> **NOTE**
+>
+> You may skip this step if you do not plan on using the Docker Containerizer.
 
 If you are using the default `mesos-init-wrapper` from the official Mesos package,
 you can enable the Docker Containerizer with the following command:
@@ -73,7 +75,9 @@ $ systemctl restart mesos-slave.service
 If you are planning to use Calico with the Unified containerizer,
 [enable the CNI Isolator on each agent](http://mesos.apache.org/documentation/latest/cni/#usage)
 
->Note: You may skip this step if you do not plan on using the Unified Containerizer.
+> **NOTE**
+>
+> You may skip this step if you do not plan on using the Unified Containerizer.
 
 When enabling CNI, you will have specified a `network_cni_config_dir`
 and `network_cni_plugins_dir`. We'll refer to these going forward as

master/getting-started/mesos/tutorials/policy/universal-containerizer.md

@@ -9,10 +9,12 @@ This document will demonstrate how to manipulate policy for Calico using
 - Configure policy based off these labels
 
 To demonstrate this, we will use Marathon to launch an nginx webserver using the Universal Containerizer.
-Then, we will launch basic curl task which will repeatedly curl the webserver.  
+Then, we will launch basic curl task which will repeatedly curl the webserver.
 
-> Note: This example assumes you are running in a DC/OS environment since it uses the DC/OS DNS to access the
-> webserver.  It is easy enough to adjust this demo for non-DC/OS environments by replacing the 
+> **NOTE**
+>
+> This example assumes you are running in a DC/OS environment since it uses the DC/OS DNS to access the
+> webserver.  It is easy enough to adjust this demo for non-DC/OS environments by replacing the
 > `webserver.marathon.containerip.dcos.thisdcos.directory` DNS name with the IP address of the webserver container.
 
 ## Setting Labels
@@ -92,7 +94,9 @@ calicoctl apply -f - <<EOF
 EOF
 ```
 
->Note: You'll need `calicoctl` configured to access your central etcd datastore. see [help]({{site.baseurl}}/{{page.version}}/reference/calicoctl/setup/etcdv2)
+> **NOTE**
+>
+> You'll need `calicoctl` configured to access your central etcd datastore. see [help]({{site.baseurl}}/{{page.version}}/reference/calicoctl/setup/etcdv2)
 
 Checking the task's log should show that these connections are no longer successful.
 

master/getting-started/openstack/neutron-api.md

@@ -145,9 +145,8 @@ attempt to create one will fail.
 
 > **NOTE**
 >
-> :   It is possible that in a future version of Calico LBaaS may be
-> :   functional. Watch this space.
->
+> It is possible that in a future version of Calico LBaaS may be
+> functional. Watch this space.
 
 ## Horizon
 

master/reference/advanced/etcd-rbac/calico-etcdv2-paths.md

@@ -5,9 +5,10 @@ title: Calico key and path prefixes in etcd v2
 The Paths listed here are the key or path prefixes that a particular calico
 component needs access to in etcd to function successfully.
 
-> **Note:** The paths listed here may change in the future and at that point
-anything referencing them (like etcd roles) would need to be updated
-appropriately.
+> **NOTE**
+>
+> The paths listed here may change in the future and at that point anything
+> referencing them (like etcd roles) would need to be updated appropriately.
 
 ## calico/node
 
@@ -90,4 +91,3 @@ appropriately.
 | /calico/v1/ipam\*          |   RW   |
 | /calico/ipam/v2\*          |   RW   |
 | /calico/bgp/v1\*           |   RW   |
-

master/reference/advanced/etcd-rbac/users-and-roles.md

@@ -9,12 +9,14 @@ Providing role based access control within etcd requires the following:
 
 This document helps with the creation of both of those.
 
-> **Note:** The etcd release 3.x+ supports both v2 and v3 of its API.
-The etcd server keeps the roles and users separate, this means that if a
-user/role is created with the v2 API it will not appear in the v3 API.
-When adding roles and users they must be added through the API version that
-matches the version the component will be using.  This concern can be ignored
-if all roles and users are added through both API versions.
+> **NOTE**
+>
+> The etcd release 3.x+ supports both v2 and v3 of its API. The etcd server
+> keeps the roles and users separate, this means that if a user/role is created
+> with the v2 API it will not appear in the v3 API. When adding roles and users
+> they must be added through the API version that matches the version the
+> component will be using.  This concern can be ignored if all roles and users
+> are added through both API versions.
 
 ## Users and Roles creation guides
 

master/reference/architecture/components.md

@@ -16,7 +16,9 @@ The [calicoctl repostiory](https://github.com/projectcalico/calicoctl) contains
 configuration files that are used to configure and "glue" these components
 together.
 
-> Note that the `calico/node` may be run in *policy only mode* in which Felix
+> **NOTE**
+>
+> `calico/node` may be run in *policy only mode* in which Felix
 > runs, but both BIRD and confd are removed.  This provides policy management
 > without route distribution between hosts.  This mode can be enabled by
 > setting the environment variable `CALICO_NETWORKING=false` before starting
@@ -65,5 +67,3 @@ For more information on confd, please refer to the [confd project](https://githu
 Calico uses a fork of the main confd repo which includes an additional change
 to improve performance with the handling of watch prefixes
 [calico-bird repo](https://github.com/projectcalico/calico-bird) for more details.
-
-

master/reference/calicoctl/commands/node/run.md

@@ -67,7 +67,7 @@ Options:
                              destination IP or domain name.
 			   > interface=<IFACE NAME REGEX LIST>
                              Use the first valid IP address found on interfaces
-                             named as per the first matching supplied interface 
+                             named as per the first matching supplied interface
 			     name regex. Regexes are separated by commas
 			     (e.g. eth.*,enp0s.*).
 			   > skip-interface=<IFACE NAME REGEX LIST>
@@ -125,7 +125,7 @@ Description:
 
 ### Kubernetes as the datastore
 
-When Calico is configured to use the Kubernetes API as the datastore, BGP routing is *currently* 
+When Calico is configured to use the Kubernetes API as the datastore, BGP routing is *currently*
 not supported.  Many of the command line options related to BGP routing will
 have no effect.  These include:
 -  `--ip`, `--ip6`, `--ip-autodetection-method`, `--ip6-autodetection-method`
@@ -179,9 +179,10 @@ force autodetection of an IPv6 address, use the option `--ip6=autodetect`.
 To set the autodetection method for IPv4, use the `--ip-autodetection-method` option.
 To set the autodetection method for IPv6, use the `--ip6-autodetection-method` option.
 
-> **Note**
+> **NOTE**
+>
 > If you are starting the calico/node container directly (and not using the
-> `calicoctl run` helper command), the options are passed in an environment
+> `calicoctl run` helper command), the options are passed in environment
 > variables.  These are described in the [calico/node configuration guide]({{site.baseurl}}/{{page.version}}/reference/node/configuration)).
 
 **first-found**
@@ -223,8 +224,8 @@ sudo calicoctl node run --ip autodetect --ip-autodetection-method can-reach=www.
 
 The `interface` method uses the supplied interface regular expressions (golang
 syntax) to enumerate matching interfaces and to return the first IP address on
-the first interface that matches any of the interface regexes provided.  The 
-order that both the interfaces and the IP addresses are listed is system 
+the first interface that matches any of the interface regexes provided.  The
+order that both the interfaces and the IP addresses are listed is system
 dependent.
 
 e.g.
@@ -292,7 +293,7 @@ terminating `,` character does not need to be specified for those cases.
                            destination IP or domain name.
 			 > interface=<IFACE NAME REGEX LIST>
                            Use the first valid IP address found on interfaces
-                           named as per the first matching supplied interface 
+                           named as per the first matching supplied interface
 			   name regex. Regexes are separated by commas
 			   (e.g. eth.*,enp0s.*).
 			 > skip-interface=<IFACE NAME REGEX LIST>

master/reference/calicoctl/resources/workloadendpoint.md

@@ -2,20 +2,20 @@
 title: Workload Endpoint Resource (workloadEndpoint)
 ---
 
-A Workload Endpoint resource (workloadEndpoint) represents an interface 
+A Workload Endpoint resource (workloadEndpoint) represents an interface
 connecting a Calico networked container or VM to its host.
 
-Each endpoint may specify a set of labels and list of profiles that Calico will use 
+Each endpoint may specify a set of labels and list of profiles that Calico will use
 to apply policy to the interface.
 
 For `calicoctl` commands that specify a resource type on the CLI, the following
 aliases are supported (all case insensitive): `workloadendpoint`, `workloadendpoints`, `wep`, `weps`.
 
-> **Note**
+> **NOTE**
 >
 > While `calicoctl` allows the user to fully manage Workload Endpoint resources,
-the lifecylce of these resources is generally handled by an orchestrator specific 
-plugin such as the Calico CNI plugin, the Calico Docker network plugin, 
+the lifecycle of these resources is generally handled by an orchestrator specific
+plugin such as the Calico CNI plugin, the Calico Docker network plugin,
 or the Calico OpenStack Neutron Driver.  In general, we recommend that you only
 use `calicoctl` to view this resource type.
 
@@ -25,7 +25,7 @@ use `calicoctl` to view this resource type.
 apiVersion: v1
 kind: workloadEndpoint
 metadata:
-  name: eth0 
+  name: eth0
   workload: default.frontend-5gs43
   orchestrator: k8s
   node: rack1-host1
@@ -34,7 +34,7 @@ metadata:
     calico/k8s_ns: default
 spec:
   interfaceName: cali0ef24ba
-  mac: ca:fe:1d:52:bb:e9 
+  mac: ca:fe:1d:52:bb:e9
   ipNetworks:
   - 192.168.0.0/16
   profiles:
@@ -68,4 +68,4 @@ spec:
 | Datastore type        | Create/Delete | Update | Get/List | Notes
 |-----------------------|---------------|--------|----------|------
 | etcdv2                | Yes           | Yes    | Yes      |
-| Kubernetes API server | No            | Yes    | Yes      | WorkloadEndpoints are directly tied to a Kuberenetes Pod.
+| Kubernetes API server | No            | Yes    | Yes      | WorkloadEndpoints are directly tied to a Kuberenetes Pod.