いままでのおさらい
前回まででnginx+gunicorn+Django2をminishiftで動作させることには成功したわけですが…
Django2プロジェクトにおける大事な要素であるcreatesuperuserを忘れていました(笑)
- Win10環境でDjango2のREST APIを試してみる
- minishift V1.28.0でDjango2を動かす①：テンプレート確認
- minishift V1.28.0でDjango2を動かす②：テンプレート＆s2iソースの作成
- minishift V1.28.0でDjango2を動かす③：s2iソースの修正＆ビルド
- minishift V1.28.0でDjango2を動かす④：残課題
- minishift V1.28.0でnginx+gunicorn+Django2を動かす
- minishift V1.28.0でnginx+gunicorn+Django2を動かす。あっcreatesuperuser忘れてた(笑)
- openshiftに対応するためのDjango2コーディング時に気を付けるべき点
SecretにDjango2のsuperuserの情報を追加する
SecretにDjango2のsuperuserの情報を追加します。
これはテンプレートファイルを修正することになります。
まずは"kind": "Secret"に項目を追加します。
修正前
:
{
"kind": "Secret",
"apiVersion": "v1",
"metadata": {
"name": "${NAME}"
},
"stringData" : {
"django-secret-key" : "${DJANGO_SECRET_KEY}"
}
},
:
修正後
:
{
"kind": "Secret",
"apiVersion": "v1",
"metadata": {
"name": "${NAME}"
},
"stringData" : {
"django-secret-key" : "${DJANGO_SECRET_KEY}",
"django-admin-user" : "${DJANGO_ADMIN_USER}",
"django-admin-email" : "${DJANGO_ADMIN_EMAIL}",
"django-admin-password" : "${DJANGO_ADMIN_PASSWORD}"
}
},
:
次にテンプレートのフォームから値を入力できるようパラメータを定義します。
具体的には"parameters"に項目を追加します。
修正前
"parameters": [
:
{
"name": "APP_CONFIG",
"displayName": "Application Configuration File Path",
"description": "Relative path to Gunicorn configuration file (optional).",
"value": "conf/gunicorn.py"
},
{
"name": "DJANGO_SECRET_KEY",
"displayName": "Django Secret Key",
"description": "Set this to a long random string.",
"generate": "expression",
"from": "[\\w]{50}"
},
:
]
修正後
"parameters": [
:
{
"name": "APP_CONFIG",
"displayName": "Application Configuration File Path",
"description": "Relative path to Gunicorn configuration file (optional).",
"value": "conf/gunicorn.py"
},
{
"name": "DJANGO_ADMIN_USER",
"displayName": "Django Admin User Name",
"required": true,
"value": "admin"
},
{
"name": "DJANGO_ADMIN_EMAIL",
"displayName": "Django Admin User's E-Mail",
"required": true,
"value": "admin@localhost"
},
{
"name": "DJANGO_ADMIN_PASSWORD",
"displayName": "Django Admin User's Password",
"generate": "expression",
"from": "[a-zA-Z0-9]{16}"
},
{
"name": "DJANGO_SECRET_KEY",
"displayName": "Django Secret Key",
"description": "Set this to a long random string.",
"generate": "expression",
"from": "[\\w]{50}"
},
:
]
パスワードDJANGO_ADMIN_PASSWORDは自動生成もできるようにしておきました。
Secret情報をDeploy時に参照する
Secretに項目を追加したので、その環境変数が必要になるフェーズ(今回はDeploy時)のセクションにenvとして参照設定を追加します。
これもテンプレートファイルを修正することになります。
ちなみにBuild時にも参照したい場合、"kind": "BuildConfig"にも追記します。
"kind": "DeploymentConfig"の中の"spec": {"containers": [内に定義されているenvに追加します。
修正前
:
{
"kind": "DeploymentConfig",
:
"template": {
"metadata": {
"name": "${NAME}",
"labels": {
"name": "${NAME}"
}
},
"spec": {
"containers": [
{
"name": "${NAME}",
"image": "${NAME}:latest",
"ports": [
{
"containerPort": 8000,
"protocol": "TCP"
}
],
"env": [
{
"name": "APP_CONFIG",
"value": "${APP_CONFIG}"
},
{
"name": "DJANGO_SECRET_KEY",
"valueFrom": {
"secretKeyRef" : {
"name" : "${NAME}",
"key" : "django-secret-key"
}
}
}
],
：
修正後
:
{
"kind": "DeploymentConfig",
:
"template": {
"metadata": {
"name": "${NAME}",
"labels": {
"name": "${NAME}"
}
},
"spec": {
"containers": [
{
"name": "${NAME}",
"image": "${NAME}:latest",
"ports": [
{
"containerPort": 8000,
"protocol": "TCP"
}
],
"env": [
{
"name": "APP_CONFIG",
"value": "${APP_CONFIG}"
},
{
"name": "DJANGO_ADMIN_USER",
"valueFrom": {
"secretKeyRef" : {
"name" : "${NAME}",
"key" : "django-admin-user"
}
}
},
{
"name": "DJANGO_ADMIN_EMAIL",
"valueFrom": {
"secretKeyRef" : {
"name" : "${NAME}",
"key" : "django-admin-email"
}
}
},
{
"name": "DJANGO_ADMIN_PASSWORD",
"valueFrom": {
"secretKeyRef" : {
"name" : "${NAME}",
"key" : "django-admin-password"
}
}
},
{
"name": "DJANGO_SECRET_KEY",
"valueFrom": {
"secretKeyRef" : {
"name" : "${NAME}",
"key" : "django-secret-key"
}
}
}
],
：
openshift(minishift)のs2iでcreatesuperuserする
実は一番苦労しました(笑)
python manage.py migrateが記載されているs2iスクリプトs2i/bin/runの後ろの処理として記載するのですが、podをスケールアップする、podが再起動する、リビルドする等した場合、またそのpodでs2i/bin/runが呼ばれます。
今回のDjango2のような実質Adminを使っていないプロジェクトやAdminを使っていてもDBがローカル(pod内の)sqliteのDBファイルを使っている場合は問題ありませんが、persistentなDBを持つプロジェクト(実際にサービスインするならこれしかないですよね)の場合は、2度目の実行で既にsuperuserが登録されておりs2i/bin/runがエラー停止してDeployが失敗します。
なので、createsuperuserする前にユーザが既に登録されているか確認し、登録されていなければ登録するという流れにしました。
また、migrateの前にmakemigrationisを行わないとユーザ独自のModelが認識され内容でしたので、追加しました。
修正前
:
if should_migrate; then
if [[ -f "$manage_file" ]]; then
echo "---> Migrating database ..."
python "$manage_file" migrate --noinput
else
echo "WARNING: seems that you're using Django, but we could not find a 'manage.py' file."
echo "Skipped 'python manage.py migrate'."
fi
fi
:
修正後
:
function should_createsuperuser() {
should_migrate
}
:
if should_migrate; then
if [[ -f "$manage_file" ]]; then
echo "---> Migrating database ..."
python "$manage_file" makemigrations --noinput
python "$manage_file" migrate --noinput
else
echo "WARNING: seems that you're using Django, but we could not find a 'manage.py' file."
echo "Skipped 'python manage.py migrate'."
fi
fi
if should_createsuperuser; then
if [[ -f "$manage_file" ]]; then
echo "---> createing super user ..."
python "$manage_file" shell <<EOF
from django.contrib.auth.models import User
if not User.objects.filter(username='$DJANGO_ADMIN_USER'):
User.objects.create_superuser('$DJANGO_ADMIN_USER', '$DJANGO_ADMIN_EMAIL', '$DJANGO_ADMIN_PASSWORD')
print(' create super user: $DJANGO_ADMIN_USER')
else:
print(' user: $DJANGO_ADMIN_USER already exists, nothing to do')
EOF
else
echo "WARNING: seems that you're using Django, but we could not find a 'manage.py' file."
echo "Skipped 'create super user'."
fi
fi
:
自動生成したSecretsの確認方法
minishift(Openshift)のWeb-Consoleから
Resources > Secrets から Nameがテンプレート名になっているものをクリックします。
表示される環境変数一覧の上にあるリンクReveal Secretをクリックすると値が見えます。
今回のGit
一応、何かあれば対応するつもりではいますが、そのスピード感は？です(笑)
- python3.6-nginx:latest … https://gitlab.com/imp555/python3.6-nginx.git
- django2-nginx-ex:latest … https://gitlab.com/imp555/django2-nginx.git