automation-framework

This is not meant to be in production, this is a development environment

Assumptions if you are using Docker with or without Swarm Mode

• You know the basics of Docker.
• You know the basics of Docker Compose.
• You know the basics of Docker Swarm.
• You know the basics of the Compose Specification.

• "Normal Compose and Swarm Files"

Assumptions if you are using Podman

• You know the basics of Podman.
• You know the basics of Podman Compose.
• You know the basics of the Compose Specification.

Assumptions if you are using Kubernetes single node or cluster

• You are using microk8s.
• You have enabled add-ons dns, metallb,

• You know the basics of Kubernetes/k8s.
• You know the basics of Kubernetes YAML.

• "Normal Kubernetes Manifests"

Assumptions if you are using HELM with Kubernetes single node or cluster

• You know the basics of HELM.

• HELM Packages

Assumptions if you are using Pod-Porter with Podman or Docker

• You know the basics of Pod-Porter

• Pod-Porter Packages

General Information

• The base Makefile is meant to be used with Docker Swarm

• The Makefile located in docker/compose is used for individual architecture pieces

• Compose does not have memory limits

Possible Special Need for ELK

• You may need to run this command on the host system

sysctl -w vm.maxmapcount=262144

Nautobot required after creating container

• You need to create a super user use the following command, and follow prompts.

docker exec -it <container-name> nautobot-server createsuperuser

Graphana iformation

• Default username admin default password admin

• It will ask you to change the password on first login

Docker registry information

• This is a insecure registry the following must be done to use it

• create daemon.json in /etc/docker and add the following

{
  "insecure-registries" : ["<ip or domain name>:5000"]
}

• restart docker daemon

sudo systemctl restart docker

• In order to use the registry in compose you must log in using the credentials' admin/admin

docker login <ip or domain name>:5000 -u admin -p admin

• You can verify you are logged in by looking in ~/.docker/config.json you should see something like this

{
	"auths": {
		"<ip or domain name>:5000": {
			"auth": "secret-key"
		}
	}
}

• To check images you add in it. In your browser.

# To see your repositories
http://<ip or domain name>:5000/v2/_catalog
To see the tags in your repositories
http://<ip or domain name>:5000/v2/<repo-name>/tags/list

Information URLs

• vm.maxmap_count
• curl examples send data to ELK
• nautobot-lab reference
• Pod-Porter
• Docker
• Docker Compose
• Docker Swarm
• Podman
• Compose Specification
• Dockerfile Reference
• Docker Compose Reference
• Docker Registry Detail
• Helm
• Kubernetes/k8s
• Kubernetes YAML
• microk8s
• microk8s add-ons
• kompose

What is Available Using Helm

Helm Charts

| ARCHITECTURE | USED FOR | |--------------------|-----------------------------------------------| | Batfish | Modeling | | ELK Elastic Search | Logging search, various other stuff | | GitLab | Pipelines and source control, docker registry | | Grafana | Pretty Graphs | | Influxdb | Series dB | | Kafka | As a message bus | | MongoDB | Document dB | | Nautobot | "Source of truth" | | RabbitMQ | Messaging | | Redis | Messaging | | TeamCity | CI/CD | | Hashicorp Vault | Secrets Storage |

What is Available Using Pod-Porter

Pod-Porter Maps

| ARCHITECTURE | USED FOR | |--------------------|-----------------------------------------------| | Batfish | Modeling | | ELK Elastic Search | Logging search, various other stuff | | GitLab | Pipelines and source control, docker registry | | Grafana | Pretty Graphs | | Influxdb | Series dB | | Kafka | As a message bus | | MongoDB | Document dB | | Nautobot | "Source of truth" | | RabbitMQ | Messaging | | Redis | Messaging | | TeamCity | CI/CD | | Hashicorp Vault | Secrets Storage |

What is Available in Swarm

| ARCHITECTURE | USED FOR | |----------------------|---------------------------------------| | Kafka | As a message bus | | ELK Elastic Search | Logging search, various other stuff | | Hashicorp Vault | Secrets Storage | | Nautobot | "Source of truth" | | A Genie Parser | Something to parse show commands |

What is Available in Compose

| ARCHITECTURE | USED FOR | |-------------------------|---------------------------------------| | Kafka | As a message bus | | ELK Elastic Search | Logging search, various other stuff | | Hashicorp Vault | Secrets Storage | | Nautobot | "Source of truth" | | A Genie Parser | Something to parse show commands | | MongoDB | Document dB | | Batfish | Modeling | | Influxdb | Series dB | | Grafana | Pretty Graphs | | Docker Registry | To hold docker images | | Docker Registry Browser | To Browse the Registry | | JetBrains TeamCity | CI/CD |

What is Available in Kubernetes

| ARCHITECTURE | USED FOR | |--------------------|---------------------------------------| | Kafka | As a message bus | | ELK Elastic Search | Logging search, various other stuff | | Hashicorp Vault | Secrets Storage | | MongoDB | Document dB | | Batfish | Modeling | | Influxdb | Series dB | | Grafana | Pretty Graphs | | JetBrains TeamCity | CI/CD |