Lazy - Kubernetes

• Makefile variables refactoring - 2023-02

Requirements

• Manala CLI to update the recipe
• Make
• Docker Desktop 2.2.0+ or Docker Engine + Docker Compose

Usage

Shell

Open a shell to container

make sh

Run commands through container shell

# From file
make sh < file
# Multilines, using heredoc
make sh << 'EOF'
command 1
command 2
...
EOF
# Single line
make sh <<< command

Specify working dir

make sh DIR=/etc <<< pwd
/etc

Expose a container port 4321 on localhost:1234

make sh PORT=1234:4321
kubectl --namespace [namespace] port-forward --address 0.0.0.0 svc/[service] 4321:[port]

Makefile

One of the first directive of your project's Makefile should be to include manala recipe Makefile

include .manala/Makefile

Or, if you're not sure manala recipe directory will be present, make it optional. If you do make it optionnal, you'll have to ensure that every parts of you project's Makefile using manala recipe tools could fallback to another solution.

-include .manala/Makefile

Note: it's a good practise to have a .SILENT: as the first line of your project's Makefile. Not only does it globally silence make targets echoing, but it also offers a lowcost debugging system by just commenting it on demand.

.SILENT:

#.SILENT:

A MANALA_DOCKER variable is available to check whether you're inside the container or not

foo:
ifdef MANALA_DOCKER
    echo Inside container
else
    echo Outside container
endif

A MANALA_DIR variable is available to get your project's directory inside container

foo:
    echo Project directory is $(MANALA_DIR)

There are three ways to force your project's Makefile target execution inside container:

1. Function manala_docker_shell

foo:
    echo Can be run *inside* or *outside* container
    $(call manala_docker_shell, echo Always run *inside* container)

2. Shell substitution with MANALA_DOCKER_SHELL

foo: SHELL := $(MANALA_DOCKER_SHELL)
foo:
    echo Always run *inside* container

# Or, if you're not sure manala recipe "Makefile" will be included
foo: SHELL := $(or $(MANALA_DOCKER_SHELL),$(SHELL))
foo:
    echo Can be run *inside* or *outside* container, \
        but always *inside* if manala recipe "Makefile" is included

3. Make substitution with MANALA_DOCKER_MAKE

foo:
    $(MANALA_DOCKER_MAKE) bar

bar:
    echo Run *outside* container if called directly \
        or *inside* container if called from "foo"

An automagic target help system is included out-of-the-box. You can list all available documented commands with make help (or just make, as the help command is the default one)

$ make

Usage: make [command]

Help:
  help This help

System:
  sh    Open a local system shell
  clean Clean local system

You can add your own documented commands, by adding double dashed comments in your projects's Makefile

## This is foo
foo:
    ...

## Bar - Use the "Bar" help section
bar.baz:
    ...

$ make

Usage: make [command]

Help:
  help This help

System:
  sh    Open a local system shell
  clean Clean local system

Commands:
  foo This is foo

Bar:
  bar.baz Use the "Bar" help section

Kubectl

Alias k

kubectl version
Client Version: ...
k version
Client Version: ...