Djangoでオブジェクトストレージをセットアップする方法

前書き

DigitalOcean Spacesはオブジェクトストレージソリューションであり、オーディオ、ビデオ、画像、大量のテキストなどの非構造化データに最適です。スペースとオブジェクトストレージの詳細については、An Introduction to DigitalOcean Spacesを参照してください。

このチュートリアルでは、スペースで動作するようにDjangoアプリケーションをセットアップする方法を説明します。

前提条件

このチュートリアルを開始するには、いくつかの設定が必要です。

DebianまたはUbuntuLinuxサーバーで設定されたsudo特権を持つ非rootユーザーアカウント。これをまだ設定していない場合は、initial server setup for Ubuntu 16.04またはDebianのチュートリアルに従ってください。
さらに、DigitalOcean Spaceを作成し、APIキーを生成する必要があります。これに関するガイダンスについては、このtutorial to create a Space and set up the API keyに従うことができます。

最初のサーバーをセットアップし、DigitalOcean SpaceとAPIキーを用意したら、準備は完了です。

[[step-1 -—- set-up-a-virtual-environment]] ==ステップ1—仮想環境をセットアップする

まだ行っていない場合は、まずサーバーを更新してアップグレードします。

sudo apt-get update && sudo apt-get -y upgrade

サーバーにはPython 3が付属していますが、次のコマンドを実行してインストールされていることを確認できます。

sudo apt-get install python3

次に、pipをインストールしてPythonのソフトウェアパッケージを管理します。

sudo apt-get install -y python3-pip

最後に、virtualenvモジュールをインストールして、プログラミング環境をセットアップすることができます。

sudo pip3 install virtualenv

programmig環境に関する追加のガイダンスと情報については、setting up a virtual environmentについて読むことができます。

[[step-2 -—- create-django-app-and-install-dependencies]] ==ステップ2—Djangoアプリを作成して依存関係をインストールする

次に、DigitalOcean Spaceを利用するDjangoアプリの作成に進みます。

サーバーのホームディレクトリにいるときに、次のコマンドを実行してディレクトリ（この場合はdjango-apps）を作成し、プロジェクトを保持してディレクトリに移動します。

mkdir django-apps
cd django-apps

このディレクトリ内で、次のコマンドを使用して仮想環境を作成します。これをenvと呼びますが、好きなように呼ぶことができます。

virtualenv env

これで、環境をアクティブ化できるようになり、コマンドラインのプレフィックスの変更により、環境内にいるというフィードバックを受け取ります。

. env/bin/activate

コマンドラインのプレフィックスの変更により、環境にいるというフィードバックを受け取ります。次のようになりますが、現在のディレクトリに応じて変わります。

環境内で、Djangoアプリを作成して実行できるように、pipでDjangoパッケージをインストールします。 Djangoの詳細については、Django Developmentに関するチュートリアルシリーズをお読みください。

pip install django

次に、次のコマンドを使用してプロジェクトを作成します。この場合は、mysiteと呼びます。

django-admin startproject mysite

次に、Boto 3をインストールします。これはAWS SDK for Pythonであり、アプリケーションがS3、EC2、DigitalOceanSpacesなどと対話できるようにします。 DigitalOcean SpacesはAmazon S3と相互運用できるため、SpacesはBoto 3などのツールと簡単にやり取りできます。 S3とSpacesの比較の詳細については、Spaces docsを確認してください。

sudo pip install boto3

私たちのプロジェクトにとって重要なもう1つのライブラリは、a collection of custom storage backends for Djangoであるdjango-storagesです。これもpipでインストールします。

sudo pip install django-storages

Djangoアプリの環境内で依存関係をセットアップし、静的ディレクトリとテンプレートディレクトリをセットアップする準備ができました。

[[step-3 -—- add-directories-and-assets]] ==ステップ3—ディレクトリとアセットを追加します

すべての依存関係で設定された環境で、mysite/mysiteディレクトリに切り替えることができます。

cd ~/django-apps/mysite/mysite

mysite/mysiteディレクトリ内で、次のコマンドを実行して静的ディレクトリとテンプレートディレクトリを作成します。

mkdir static && mkdir templates

次に、staticディレクトリ内に存在する画像とCSSのサブディレクトリを作成します。

mkdir static/img && mkdir static/css

ディレクトリを作成したら、テストファイルをダウンロードし、最終的にオブジェクトストレージに追加します。イメージをダウンロードするので、imgディレクトリに切り替えます。

cd ~/django-apps/mysite/mysite/static/img

このディレクトリ内で、Wgetのwgetコマンドを使用してDigitalOceanロゴ画像をダウンロードします。これは、Ubuntuディストリビューションにプリインストールされ、Webサーバーからコンテンツを取得するためによく使用されるGNUプログラムです。

wget http://assets.digitalocean.com/logos/DO_Logo_icon_blue.png

次のような出力が表示されます。

OutputResolving www.digitalocean.com (www.digitalocean.com)... 104.16.24.4, 104.16.25.4
Connecting to www.digitalocean.com (www.digitalocean.com)|104.16.24.4|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 1283 (1.3K) [image/png]
Saving to: ‘DO_Logo_icon_blue.png’

DO_Logo_icon_blue-6edd7377 100%[=====================================>]   1.25K  --.-KB/s    in 0s

2017-11-05 12:26:24 (9.60 MB/s) - ‘DO_Logo_icon_blue.png’ saved [1283/1283]

この時点で、コマンドlsを実行すると、DO_Logo_icon_blue.pngという名前のイメージがstatic/img/ディレクトリに存在することがわかります。

これらのディレクトリがセットアップされ、画像がサーバーにダウンロードされて保存されるので、Djangoアプリに関連するファイルの編集に進むことができます。

[[step-4 -—- edit-css-and-html-files]] ==ステップ4—CSSおよびHTMLファイルを編集する

まず、スタイルシートを編集します。 Webアプリの基本的なスタイルシートを追加できるように、cssディレクトリに移動する必要があります。

cd ~/django-apps/mysite/mysite/static/css

nano、または選択した別のテキストエディターを使用して、ドキュメントを編集します。

nano app.css

ファイルが開いたら、次のCSSを追加します。

app.css

body {
  margin: 0;
  background-color: #f1f1f1;
  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
}

.container {
  width: 80%;
  border: 1px solid #ddd;
  background-color: #fff;
  padding: 20px;
  margin: 40px auto;
}

form {
  margin-bottom: 20px;
  padding: 10px;
  border: 1px solid #ff9900;
  width: 350px;
}

table {
  border-collapse: collapse;
  width: 100%;
}

table td,
table th {
  border: 1px solid #eceeef;
  padding: 5px 8px;
  text-align: left;
}

table thead {
  border-bottom: 2px solid #eceeef;
}

終了したら、ファイルを保存して閉じることができます。ここから、templatesディレクトリに移動します。

cd ~/django-apps/mysite/mysite/templates

基本的なWebアプリの表示方法として、home.htmlというファイルを開き、そのファイルにHTMLを追加する必要があります。 nanoを使用して、ファイルを開いて編集の準備をします。

nano home.html

ドキュメント内に、次を追加します。

home.html

{% load static %}



  
  Spaces + Django Tutorial
  


  
  
    Spaces + Django Tutorial
  
  
    
    Congratulations, you’re using Spaces!

ファイルを保存して閉じます。最後に更新するファイルはurls.pyファイルで、新しく作成したhome.htmlファイルを指します。次のディレクトリに移動する必要があります。

cd ~/django-apps/mysite/mysite

nanoを使用してurls.pyファイルを編集します。

nano urls.py

ファイル内のすべてを削除してから、次を追加できます。

urls.py

from django.conf.urls import url
from django.views.generic import TemplateView


urlpatterns = [
    url(r'^$', TemplateView.as_view(template_name='home.html'), name='home'),
]

これらのファイルを設定したら、settings.pyファイルを編集してオブジェクトストレージと統合することができます。

[[step-5 --- update-settings]] ==ステップ5—設定を更新します

次に、設定ファイルをSpacesの資格情報で更新して、セットアップしたページを利用して画像を表示できるようにします。

この例では、簡潔にするために資格情報をハードコーディングすることに注意してください。ただし、これは本番環境のセットアップには十分ではありません。 Spacesの資格情報をマスクするようなPython Decoupleのようなパッケージを使用することをお勧めします。このパッケージは、プロダクショングレードのDjangoアプリケーションに必要なソースコードから設定パラメーターを分離します。

まず、設定ファイルの場所に移動します。

cd ~/django-apps/mysite/mysite

nanoを使用して、編集用にファイルを開きます。

nano settings.py

サーバーのIPを許可されたホストとして追加します。

settings.py

...
ALLOWED_HOSTS = ['your-server-ip']
...

次に、設定ファイルのインストール済みアプリセクションにstoragesを追加し、このチュートリアルでは使用しないため、django.contrib.adminを削除します。次のようになります。

settings.py

...
# Application definition

INSTALLED_APPS = [
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'storages'
]
...

強調表示されたテキストを置き換えて、設定ファイルのTEMPLATESセクションに追加します。これにより、プロジェクトはhome.htmlファイルの場所を認識できます。

settings.py

...
TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'mysite/templates')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]
...

最後に、ファイルの下部で設定を更新しましょう。 # Static filesセクションの下に以下を追加します。必ず、独自のアクセスキー、バケット名、およびファイルを保存するディレクトリを追加してください。 Spacesインターフェースのブラウザーでディレクトリを追加できます。執筆時点では、NYC3は現在Spacesが存在する唯一の地域であるため、エンドポイントURLとして渡されています。

settings.py

...
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/1.11/howto/static-files/

AWS_ACCESS_KEY_ID = 'your-spaces-access-key'
AWS_SECRET_ACCESS_KEY = 'your-spaces-secret-access-key'
AWS_STORAGE_BUCKET_NAME = 'your-storage-bucket-name'
AWS_S3_ENDPOINT_URL = 'https://nyc3.digitaloceanspaces.com'
AWS_S3_OBJECT_PARAMETERS = {
    'CacheControl': 'max-age=86400',
}
AWS_LOCATION = 'your-spaces-files-folder'

STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'mysite/static'),
]
STATIC_URL = 'https://%s/%s/' % (AWS_S3_ENDPOINT_URL, AWS_LOCATION)
STATICFILES_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'

これで、設定ファイルでDjangoアプリとオブジェクトストレージを統合する準備が整いました。

[[step-6 --- collect-static-files]] ==ステップ6—静的ファイルを収集します

ここでcollectstaticを実行すると、静的ディレクトリに保存した画像を含むファイルが転送されていることがわかります。設定ファイルで特定したSpacesの場所に転送されます。

これを実現するために、~/django-apps/mysite/に移動しましょう：

cd ~/django-apps/mysite

ディレクトリ内で、次のコマンドを実行します。

python manage.py collectstatic

次の出力が表示され、プロンプトが表示されたらyesと応答するはずです。

OutputYou have requested to collect static files at the destination
location as specified in your settings.

This will overwrite existing files!
Are you sure you want to do this?

Type 'yes' to continue, or 'no' to cancel:

その後、ファイルがSpacesにコピーされたことを示す出力がさらに表示されます。

OutputCopying '/root/django-apps/mysite/mysite/static/css/app.css'

1 static file copied, 1 unmodified.

この時点で、DigitalOcean Cloudアカウントからバケットに戻ると、ポイントしたフォルダーにcssおよびimgディレクトリが追加され、app.cssがcssディレクトリ、およびimgディレクトリ内のDO-Logo_icon_blue-.pngイメージ。

[[step-7 -—- test-the-application]] ==ステップ7—アプリケーションをテストします

すべての設定とオブジェクトストレージ内のファイルを使用して、静的ファイルが提供されているページに移動して、アプリケーションをテストできます。

まず、次のコマンドを発行して、ファイアウォールがポート8000を通過するトラフィックを許可することを確認します。

sudo ufw allow 8000

これで、サーバーのIPアドレスを参照し、ポート8000を使用してサーバーを実行できます。

python manage.py runserver your-server-ip:8000

Webブラウザーで、http://your-server-ip:8000に移動して、作成したDjangoアプリケーションの結果を確認します。ブラウザに次の出力が表示されます。

DigitalOcean Spaces Django Example App

アプリのテストが終了したら、CTRL +Cを押してrunserverコマンドを停止できます。これにより、プログラミング環境に戻ります。

Python環境を終了する準備ができたら、deactivateコマンドを実行できます。

deactivate

プログラミング環境を非アクティブ化すると、ターミナルコマンドプロンプトに戻ります。

結論

このチュートリアルでは、DigitalOcean Spacesのファイルを提供するDjangoアプリケーションを正常に作成しました。静的ファイル、静的ファイルの管理方法、クラウドサービスから静的ファイルを提供する方法について学習しました。

Django Developmentに関するチュートリアルシリーズを読むことで、PythonとDjangoを使用したWeb開発について引き続き学習できます。

TOC

Djangoでオブジェクトストレージをセットアップする方法

前書き

前提条件

Spaces + Django Tutorial

Congratulations, you’re using Spaces!

結論

Related