Cara Membuka Shell Interaktif dengan Docker Compose Exec
Pelajari docker compose exec web bash untuk membuka shell pada service yang sedang berjalan, serta docker compose run untuk membuat container baru saat service berhenti.
Dapatkan shell interaktif dengan docker compose exec
docker compose exec web bash membuka shell interaktif di dalam container yang sedang berjalan sebagai service web. Nama setelah exec adalah nama service dari compose.yaml, bukan nama container. Jika image tidak memiliki bash, gunakan sh.
docker compose ps
docker compose exec web bashJalankan docker compose ps terlebih dahulu. Perintah tersebut harus menampilkan web dengan status running. Kemudian, perintah kedua menempatkan Anda pada prompt di dalam container. exit atau Ctrl-D mengembalikan Anda ke host. Service tetap berjalan setelah Anda keluar karena exec memulai proses kedua di samping proses utama. Menutup shell tidak memengaruhi PID 1 (process id 1), yaitu proses yang dirancang untuk dijalankan oleh container.
Itu adalah salah satu dari dua cara untuk masuk. exec bergabung dengan container yang sudah ada. docker compose run membuat container baru dari definisi service yang sama. Hampir semua hal lain dalam panduan ini mengikuti satu perbedaan tersebut.
Mengapa -it bersifat opsional di Compose, tetapi diperlukan dengan docker biasa
Dua flag mengatur bagian interaktif suatu sesi. -i menjaga stdin tetap terbuka, sehingga input yang Anda ketik diteruskan ke proses. -t mengalokasikan pseudo-terminal yang disebut TTY, sehingga shell menampilkan prompt dan menangani tombol panah. docker exec biasa menonaktifkan keduanya secara default. Karena itu, setiap contoh yang telah Anda lihat menuliskan docker exec -it. docker compose exec mengaktifkan keduanya untuk Anda, sehingga docker compose exec -it web bash dan docker compose exec web bash menghasilkan hal yang sama. Compose tetap menerima -it agar kebiasaan lama tetap dapat digunakan.
Anda akan segera mengetahui jika TTY tidak tersedia. Shell berjalan, tetapi tidak menampilkan prompt dan Ctrl-C tidak pernah diteruskan ke proses. Kasus sebaliknya, ketika Anda harus meminta Compose untuk tidak mengalokasikan TTY, memiliki flag tersendiri dan bagian tersendiri di bawah.
Yang harus dilakukan jika image tidak memiliki bash
Jika Anda meminta bash dari image berbasis Alpine, perintah exec dapat gagal seperti ini:
OCI runtime exec failed: exec failed: unable to start container process: exec: "bash": executable file not found in $PATH: unknownPesan tersebut bukan menunjukkan masalah pada exec. Pesan itu berarti tidak ada bash yang ditemukan di direktori yang tercantum dalam PATH milik container. Untuk shell, penyebabnya hampir selalu image tersebut tidak menyertakan bash. Alpine menyertakan BusyBox, yang menyediakan ash sebagai /bin/sh, tetapi tidak menyertakan bash sama sekali. Karena itu, minta sh:
docker compose exec web shImage berbasis Debian dan Ubuntu, termasuk tag -slim, memang menyertakan bash. Bash menyediakan riwayat perintah dan pelengkapan yang lebih baik. Jadi, coba bash terlebih dahulu lalu gunakan sh sebagai cadangan. sh tersedia di hampir semua image untuk penggunaan umum.
Beberapa image tidak memiliki shell sama sekali. Image Distroless dan image yang dibangun FROM scratch hanya berisi binary aplikasi beserta library-nya. Ini memang disengaja, karena shell yang tidak tersedia tidak dapat digunakan untuk menyerang Anda. Pada image tersebut, sh gagal dengan pesan yang sama dan tidak ada opsi lain yang dapat dicoba. Ada 2 pendekatan yang dapat digunakan. Image Distroless dari Google menyediakan tag :debug yang menambahkan shell BusyBox. Anda dapat mengganti tag tersebut sementara untuk masuk ke dalam container. Atau, jalankan container terpisah di dalam namespace milik target:
CID=$(docker compose ps -q web)
docker run --rm -it --network "container:$CID" --pid "container:$CID" nicolaka/netshootKini Anda memiliki tool dari netshoot yang diarahkan ke network aplikasi. Dengan demikian, curl localhost:8080 dan ss -lntp berperilaku seolah-olah Anda berada di dalam container aplikasi tersebut. Filesystem yang Anda lihat adalah filesystem milik netshoot, bukan milik aplikasi. Karena process namespace digunakan bersama, /proc/1/root/ mengarah ke filesystem proses target. Namun, ls /proc/1/root/ tetap harus melewati pemeriksaan izin ptrace dari kernel. Kedua proses yang berjalan sebagai root saja tidak cukup. Pemeriksaan tersebut juga mempertimbangkan kredensial, capability, atribut dumpable milik target, dan security module. Nilai dumpable selain 1 memblokir akses, kecuali caller memiliki CAP_SYS_PTRACE di dalam user namespace target. Docker tidak memberikan SYS_PTRACE secara default. Menambahkan --cap-add SYS_PTRACE ke baris docker run menangani pemeriksaan kredensial dan dumpability, tetapi security module masih dapat menolak akses.
Saat service tidak berjalan, gunakan docker compose run --rm
exec memerlukan container yang sedang berjalan. Jika diarahkan ke service yang berhenti, perintah ini akan menolak:
service "web" is not runningPerintah ini tidak akan menjalankan apa pun untuk Anda. docker compose run akan:
docker compose run --rm web bashrun membuat container baru dari definisi service web, dengan image, environment, volume, dan network yang sama, lalu mengganti command service dengan command yang Anda ketik. --rm menghapus container tersebut saat Anda keluar. Jika --rm tidak digunakan, container sisa akan menumpuk dengan nama seperti myproject-web-run-4f1c2b. docker compose ps -a akan menampilkannya, sedangkan docker compose rm menghapusnya bersama container lain milik service yang sudah berhenti.
Dua perilaku run sering mengejutkan pengguna. Perintah ini tidak memublikasikan port service kecuali Anda menambahkan --service-ports atau memetakan port secara manual dengan -p. Hal ini memang disengaja: container kedua yang mengikat port host 8080 saat container pertama masih menggunakannya akan gagal dengan bind: address already in use. Perintah ini juga menjalankan semua yang tercantum dalam depends_on sebelum shell Anda muncul. Pemeriksaan singkat ke dalam container dapat menyebabkan database dan cache ikut berjalan. --no-deps menonaktifkan perilaku tersebut.
run melewati ENTRYPOINT image, sedangkan exec tidak. exec menjalankan command Anda secara langsung di container yang sudah ada, sehingga skrip entrypoint tidak pernah menerimanya. Dengan run, bash diteruskan sebagai argumen ke skrip tersebut. Banyak image resmi mengakhiri entrypoint dengan exec "$@", sehingga argumen diteruskan langsung dan Anda mendapatkan shell. Skrip yang menafsirkan argumennya sendiri akan melakukan hal lain terhadap argumen tersebut. Dalam kasus itu, ganti entrypoint untuk satu kali proses run:
docker compose run --rm --entrypoint sh webInilah alasan paling umum command yang berjalan dengan exec berperilaku berbeda saat dijalankan dengan run. Perbedaan antara command dan entrypoint menjelaskan bagian mana dari konfigurasi image yang Anda ganti setiap kali.
exec atau run: cara memilih
- exec memerlukan container yang sedang berjalan. run tidak memerlukannya dan dapat menjalankan dependensi.
- exec melihat daftar proses yang aktif dan file dalam kondisi saat ini, termasuk apa pun yang telah ditulis aplikasi sejak mulai berjalan. run mendapatkan writable layer baru dari image, tetapi named volume dan bind mount tetap mengekspos data yang sudah ada pada service.
- exec melewati entrypoint. run menjalankannya.
- run meninggalkan container kecuali Anda meneruskan
--rm.
Gunakan exec untuk memeriksa apa yang sebenarnya sedang terjadi. Gunakan run --rm untuk salinan sementara dari lingkungan yang sama, untuk menjalankan perintah migrasi satu kali, atau ketika service sebenarnya tidak bertahan cukup lama untuk diakses dengan exec.
Flag exec yang berguna: user, direktori kerja, dan replica
Sebagian besar image beralih ke user non-root. Karena itu, pemasangan alat diagnostik di dalam shell exec berhenti pada tahap ini:
E: Could not open lock file /var/lib/dpkg/lock-frontend - open (13: Permission denied)-u root memberi Anda shell root di container yang sama:
docker compose exec -u root web sh-w /srv/app menetapkan direktori kerja hanya untuk perintah tersebut. -e KEY=value menambahkan variabel lingkungan ke sesi Anda, bukan ke service. Jika sebuah service menjalankan lebih dari satu replica, --index 2 menentukan container yang Anda gunakan. Jika yang sedang Anda telusuri adalah kepemilikan file pada direktori yang di-mount, PUID dan PGID pada image container menjelaskan mengapa ID numerik, bukan nama user, menentukan pihak yang dapat menulis di sana.
Mendapatkan shell psql atau mysql di dalam container database
Client sudah tersedia di dalam image database. Jadi, Anda tidak memerlukannya di host dan tidak perlu memublikasikan port:
docker compose exec db psql -U postgres -d app
docker compose exec db mariadb -u root -pImage Postgres menyertakan psql, image MySQL menyertakan mysql, dan image MariaDB menyertakan mariadb. Koneksi dibuat dari dalam container. Karena itu, cara ini tetap berfungsi meskipun compose file sama sekali tidak memublikasikan port database. Ini adalah pengaturan yang lebih aman pada bridge networking default Docker: host eksternal tidak dapat mengakses port database yang tidak dipublikasikan secara langsung, meskipun Docker host dan container pada jaringan yang sama masih dapat mengaksesnya.
Ada satu jebakan yang dapat menghabiskan waktu berjam-jam. Shell Anda memperluas variabel di host sebelum Docker menerima perintah. Karena itu, -U "$POSTGRES_USER" mengirim string kosong jika variabel tersebut hanya tersedia di dalam container. Gunakan tanda kutip tunggal dan shell di dalam container agar variabel diperluas di tempat yang benar:
docker compose exec db sh -c 'psql -U "$POSTGRES_USER" -d "$POSTGRES_DB"'Jangan langsung menggunakan docker compose run --rm db tanpa perintah di sini. Perintah tersebut memulai server Postgres kedua pada data volume yang sama, lalu server itu gagal start:
FATAL: lock file "postmaster.pid" already existsFile lock menjalankan fungsinya. Dua server yang menulis ke satu direktori data dapat merusak data tersebut. Saat database sedang berjalan, gunakan exec ke container yang sedang aktif. Keputusan apakah database memang perlu dijalankan dalam Compose merupakan hal terpisah. menjalankan database di Docker atau di host menjelaskan berbagai pertimbangannya.
Layanan yang memerlukan konsol saat startup: stdin_open dan tty
exec dan run digunakan untuk shell yang Anda buka secara manual. Layanan yang proses utamanya bersifat interaktif memerlukan dua key dalam file compose:
services:
console:
image: python:3.12-slim
command: python
stdin_open: true
tty: truestdin_open: true adalah docker run -i dan tty: true adalah docker run -t. Tanpa keduanya, container langsung start lalu exit dengan code 0, dan docker compose ps -a menampilkan Exited (0). Tidak ada yang mengalami crash. python tanpa terminal pada stdin segera membaca end-of-file lalu berhenti secara normal. Ini adalah perilaku yang benar untuk program yang tidak menerima input dari pengguna.
Setelah kedua key ditetapkan, attach ke proses yang sedang berjalan:
docker attach $(docker compose ps -q console)Lakukan detach dengan menekan Ctrl-P lalu Ctrl-Q. Proses akan tetap berjalan. Urutan ini hanya berfungsi jika container memiliki TTY dan stdin yang terbuka. Sebaliknya, Ctrl-C mengirim interrupt (SIGINT) ke PID 1. Tindakan ini hanya menghentikan layanan jika program tersebut diprogram untuk exit saat menerima SIGINT, karena Linux tidak memberikan penanganan sinyal default kepada PID 1. Karena itu, jangan gunakan Ctrl-C untuk detach.
Biarkan kedua key tersebut tidak ditetapkan untuk layanan biasa. Web server tidak pernah membaca stdin, sedangkan tty: true membuat banyak program beralih ke output berwarna dan line buffering karena program menganggap ada orang yang sedang melihatnya. Akibatnya, docker compose logs dipenuhi escape code.
Mengapa exec berbasis skrip gagal di cron dan CI: flag -T
Perintah exec yang berhasil di terminal dapat gagal saat dijalankan oleh skrip, cron job, runner continuous integration (CI), atau pipe:
the input device is not a TTYCompose meminta pseudo-terminal saat output-nya sendiri diarahkan ke terminal. Permintaan ini gagal sebelum perintah Anda dijalankan jika stdin juga bukan terminal. Source code Docker CLI terbaru menyebut kegagalan yang sama sebagai cannot attach stdin to a TTY-enabled container because stdin is not a terminal. Compose versi saat ini melewati permintaan tersebut secara otomatis saat output dialihkan atau disalurkan melalui pipe, seperti yang biasanya terjadi di cron. Beberapa rilis sebelumnya tetap mengajukan permintaan tersebut, dan cat dump.sql | docker compose exec db psql yang diketik pada prompt Anda sendiri masih memicunya hingga sekarang. -T menonaktifkan permintaan tersebut dalam semua kondisi. Karena itu, gunakan flag ini dalam skrip dan jangan mengandalkan deteksi otomatis:
0 3 * * * docker compose -f /srv/app/compose.yaml exec -T db pg_dump -U postgres -Fc app > /srv/backups/app.dump-T penting karena alasan kedua. TTY menulis ulang aliran byte saat meneruskannya, sehingga dump terkompresi yang melewatinya akan rusak. Gunakan -T secara eksplisit untuk setiap output yang dialihkan atau disalurkan melalui pipe.
Ada 2 detail cron lainnya. Gunakan -f bersama path absolut, karena cron menjalankan job dari direktori home yang tidak berisi compose file. Compose kemudian berhenti dengan no configuration file provided: not found. Selain itu, exec mengembalikan exit code dari perintah yang dijalankannya. Karena itu, pg_dump yang gagal akan menggagalkan skrip Anda di bawah set -e, bukan membuat backup kosong lalu melaporkan keberhasilan. Perintah sehari-hari lainnya dirangkum dalam lembar referensi cepat perintah Compose yang sebaiknya disimpan di dekat skrip tersebut.
Mengapa perubahan yang Anda buat di dalam container hilang
Anda menginstal alat dengan exec, mengedit file konfigurasi, memperbaiki masalah, lalu seminggu kemudian perbaikan tersebut hilang. Ini adalah perilaku writable layer milik container yang berjalan sesuai desain. docker compose up -d setelah ada perubahan pada image tag atau service definition akan menghancurkan container lama dan membuat container baru dari image. Semua pengeditan manual ikut hilang bersama container lama.
docker compose restart berbeda. Operasi ini menghentikan dan menjalankan container yang sama, sehingga pengeditan manual tetap ada. Karena itu, perbaikan manual dapat terlihat bertahan selama berminggu-minggu, lalu hilang saat pembaruan yang tidak terkait. Named volumes dan bind mounts tetap ada setelah kedua operasi tersebut karena datanya disimpan di luar container. bind mounts dan named volumes menjelaskan cara memilih salah satunya untuk data yang ingin Anda pertahankan.
Anggap shell exec sebagai tempat untuk membaca dan menguji. Setelah Anda mengetahui perbaikannya, tuliskan perbaikan tersebut di tempat yang dapat mempertahankannya: masukkan package ke dalam Dockerfile dan masukkan setting ke dalam compose file. Lalu docker compose up -d untuk menerapkannya, kemudian lakukan exec lain untuk memastikan container baru benar-benar memilikinya.
FAQ
Apa perbedaan antara docker compose exec dan docker compose run?
exec menjalankan perintah di dalam container yang sudah berjalan, di samping proses utama, dan melewati entrypoint image. run membuat container baru dari definisi service yang sama dengan image, environment, volume, dan network yang sama, meneruskan perintah melalui entrypoint, serta menjalankan service depends_on terlebih dahulu. run juga tidak memublikasikan port service, kecuali Anda menambahkan --service-ports atau mapping -p. Gunakan exec untuk memeriksa service yang sedang berjalan. Gunakan run --rm jika service berhenti atau Anda memerlukan container terpisah. Ingat bahwa named volume dan bind mount digunakan bersama.
Mengapa docker compose exec melaporkan bahwa service tidak berjalan?
exec terhubung ke container yang sudah ada dan tidak dapat membuat container baru. Karena itu, service yang berhenti atau mengalami crash menghasilkan service "web" is not running. Periksa docker compose ps -a, yang menampilkan container yang sudah berhenti dengan status seperti Exited (1), lalu baca docker compose logs web untuk mengetahui alasan service berhenti. Untuk tetap mendapatkan shell, jalankan docker compose run --rm --entrypoint sh web. Perintah ini membuat container baru dari definisi service yang sama tanpa menjalankan start command yang bermasalah.
Bagaimana cara membuka shell jika image tidak memiliki bash?
Kegagalan docker compose exec web bash dengan pesan exec: "bash": executable file not found in $PATH berarti bash tidak ditemukan dalam direktori pada PATH container. Hampir selalu, ini berarti image tidak menyertakan bash. Hal tersebut normal pada image yang dibuat dengan Alpine. Gunakan docker compose exec web sh karena BusyBox menyediakan /bin/sh. Pada image yang tidak memiliki shell, exec tidak dapat membuka shell, tetapi tetap dapat menjalankan executable yang tersedia di dalam image. Gunakan tag :debug milik image jika publisher menyediakannya, atau jalankan debug container pada namespace target dengan docker run --rm -it --network "container:$CID" --pid "container:$CID" nicolaka/netshoot, dengan $CID yang diperoleh dari docker compose ps -q web.
Mengapa perintah exec saya gagal dengan pesan "the input device is not a TTY" di cron?
docker compose exec meminta pseudo-terminal saat output diarahkan ke terminal. Permintaan tersebut gagal jika stdin juga bukan terminal. Compose versi saat ini secara otomatis melewati permintaan tersebut saat output dialihkan, seperti yang biasanya terjadi di cron. Namun, beberapa rilis sebelumnya tetap mengajukan permintaan tersebut, dan piping input ke exec dari interactive shell masih memicunya. Tambahkan -T untuk menonaktifkannya: docker compose exec -T db pg_dump -U postgres app. Gunakan -T untuk output yang dialihkan atau dipipe, karena TTY mengubah aliran byte dan dapat merusak binary dump. Di cron, sertakan juga -f dengan path absolut ke file compose. Jika tidak, Compose keluar dengan no configuration file provided: not found.
Apakah perubahan yang saya buat di dalam container dengan exec tetap ada setelah restart?
Perubahan tersebut tetap ada setelah docker compose restart, yang menggunakan kembali container yang sama. Perubahan tersebut hilang setelah docker compose up -d jika ada perubahan pada image atau konfigurasi, karena proses ini membuat ulang container dari image dan membuang writable layer-nya. Data yang ditulis ke named volume atau bind mount tetap ada setelah kedua tindakan tersebut karena data berada di luar container. Gunakan exec untuk perubahan diagnostik, lalu masukkan versi permanennya ke Dockerfile atau file compose.