Conventions used
There are a number of text conventions used throughout this book.
Code in text
: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: "This requires additional resources, such as ClusterRoles
and RoleBindings
, to ensure the Prometheus Pod has permission to scrape metrics from the cluster and its applications."
A block of code is set as follows:
apiVersion: monitoring.coreos.com/v1
kind: Prometheus
metadata:
name: sample
spec:
replicas: 2
When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: web-service-monitor
labels:
app: web
spec:
selector:
matchLabels:
serviceLabel: webapp
Any command-line input or output is written as follows:
$ export BUNDLE_IMG=docker.io/sample/nginx-bundle:v0.0.2 $ make bundle-build bundle-push $ operator-sdk run bundle docker.io/same/nginx-bundle:v0.0.2
Bold: Indicates a new term, an important word, or words that you see on screen. For instance, words in menus or dialog boxes appear in bold. Here is an example: "Clicking on the Grafana Operator tile opens up the information page for this specific Operator."
Tips or Important Notes
Appear like this.