第16章 カスタマイズ

インスタンス上で、Folsom の安定版用の DevStack を動作させるためには：

1. ダッシュボード、または nova のコマンドラインインタフェース(CLI)から、以下のパラメータでインスタンスを起動してください。

   • 名前: devstack

   • イメージ: Ubuntu 12.04 LTS

   • メモリサイズ: 4 GB RAM (おそらく 2 GB でもなんとかなるでしょう)

   • ディスクサイズ: 最低 5 GB

   nova コマンドを使っているのであれば、適切なメモリ量とディスクサイズを得るために nova boot コマンドに --flavor 6 を指定してください。

2. 利用するイメージで root ユーザしか使えない場合、「stack」ユーザを作成しなければなりません。でなければ、stack.sh スクリプトに「stack」ユーザを作成させる時に、screen に関するパーミッションの問題にぶつかります。利用するイメージに、既に root 以外のユーザがあるのであれば、このステップは省略できます。

   1. ssh root@<IP Address>

   2. adduser --gecos "" stack

   3. プロンプトに対して新しいパスワードを入力します。

   4. adduser stack sudo

   5. grep -q "^#includedir.*/etc/sudoers.d" /etc/sudoers || echo "#includedir /etc/sudoers.d" >> /etc/sudoers

   6. ( umask 226 && echo "stack ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/50_stack_sh )

   7. exit

3. stack ユーザとしてログインし、DevStack の設定を行います。

   1. ssh stack@<IP address>

   2. プロンプトに対して、stack ユーザに作ったパスワードを入力します。

   3. sudo apt-get -y update

   4. sudo apt-get -y install git

   5. git clone https://github.com/openstack-dev/devstack.git -b stable/folsom devstack/

   6. cd devstack

   7. vim localrc

      • Swift のみ、ミドルウェア例 で使用された, 以下の [1] Swift only localrc の例を参照してください。

      • 他のすべてのプロジェクトについて、 Nova Scheduler Example で使用された, 以下の [2] All other projects localrc の例を参照してください。

   8. ./stack.sh

   9. screen -r stack 

   注記

   stack.sh の実行には、しばらく時間がかかります。できれば、この時間を使って OpenStack ファウンデーションに参加してください (http://www.openstack.org/join/)。 stack.sh を実行する際、“ERROR: at least one RPC back-end must be enabled” というエラーメッセージが出るかもしれません。これは心配しないでください。swift と keystone はRPC (AMQP) バックエンドを必要としないのです。同様に、ImportErrors はすべて無視できます。 Screen は、多くの関連するサービスを同時に見るための便利なプログラムです。GNU screen quick reference. (http://aperiodic.net/screen/quick_reference) を参照してください。

ミドルウェアを作成して Paste の環境設定を通して組み込むためには：

1. すべての OpenStack のコードは /opt/stack にあります。shell セッションの screen の中で swift ディレクトリに移動し、あなたのミドルウェアモジュールを編集してください。

   1. cd /opt/stack/swift

   2. vim swift/common/middleware/ip_whitelist.py

2. 以下のコードをコピーしてください。作業が終わったら、ファイルを保存して閉じてください。

   # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   #
                        
   #    http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   # implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.
   import socket
    
   from swift.common.utils import get_logger
   from swift.proxy.controllers.base import get_container_info
   from swift.common.swob import Request, Response
    
   class IPWhitelistMiddleware(object):
       """
       IP Whitelist Middleware
   
       Middleware that allows access to a container from only a set of IP
       addresses as determined by the container's metadata items that start
       with the prefix 'allow'. E.G. allow-dev=192.168.0.20
       """
   
       def __init__(self, app, conf, logger=None):
           self.app = app
   
           if logger:
               self.logger = logger
           else:
               self.logger = get_logger(conf, log_route='ip_whitelist')
   
           self.deny_message = conf.get('deny_message', "IP Denied")
           self.local_ip = socket.gethostbyname(socket.gethostname())
   
       def __call__(self, env, start_response):
           """
           WSGI entry point.
           Wraps env in swob.Request object and passes it down.
   
           :param env: WSGI environment dictionary
           :param start_response: WSGI callable
           """
           req = Request(env)
   
           try:
               version, account, container, obj = req.split_path(1, 4, True)
           except ValueError:
               return self.app(env, start_response)
   
           container_info = get_container_info(
               req.environ, self.app, swift_source='IPWhitelistMiddleware')
   
           remote_ip = env['REMOTE_ADDR']
           self.logger.debug(_("Remote IP: %(remote_ip)s"),
                             {'remote_ip': remote_ip})
   
           meta = container_info['meta']
           allow = {k:v for k,v in meta.iteritems() if k.startswith('allow')}
           allow_ips = set(allow.values())
           allow_ips.add(self.local_ip)
           self.logger.debug(_("Allow IPs: %(allow_ips)s"),
                             {'allow_ips': allow_ips})
   
           if remote_ip in allow_ips:
               return self.app(env, start_response)
           else:
               self.logger.debug(
                   _("IP %(remote_ip)s denied access to Account=%(account)s "
                     "Container=%(container)s. Not in %(allow_ips)s"), locals())
               return Response(
                   status=403,
                   body=self.deny_message,
                   request=req)(env, start_response)
   
   
   def filter_factory(global_conf, **local_conf):
       """
       paste.deploy app factory for creating WSGI proxy apps.
       """
       conf = global_conf.copy()
       conf.update(local_conf)
   
       def ip_whitelist(app):
           return IPWhitelistMiddleware(app, conf)
       return ip_whitelist
                    

   env と conf には、リクエストについて何をするのか判断するのに使える有用な情報が多数含まれています。どんなプロパティが利用可能なのかを知るには、以下のログ出力文を __init__ メソッドに挿入してください。

   self.logger.debug(_("conf = %(conf)s"), locals())

   そして以下のログ出力分を __call__ メソッドに挿入してください。

   self.logger.debug(_("env = %(env)s"), locals())

3. このミドルウェアを Swift のパイプラインに組み込むには、設定ファイルを1つ編集する必要があります。

    vim /etc/swift/proxy-server.conf

4. [filter:ratelimit] セクションを探し、以下の環境定義セクションを貼り付けてください。

   [filter:ip_whitelist]
   paste.filter_factory = swift.common.middleware.ip_whitelist:filter_factory
   # You can override the default log routing for this filter here:
   # set log_name = ratelimit
   # set log_facility = LOG_LOCAL0
   # set log_level = INFO
   # set log_headers = False
   # set log_address = /dev/log
   deny_message = You shall not pass!

5. [pipeline:main] セクションを探し、このように ip_whitelist リストを追加してください。完了したら、ファイルを保存して閉じてください。

   [pipeline:main]
   pipeline = catch_errors healthcheck cache ratelimit ip_whitelist authtoken keystoneauth proxy-logging proxy-server

6. Swift にこのミドルウェアを使わせるために、Swift プロキシサービスを再起動します。swift の screen セッションに切り替えてはじめてください。

   1. Ctrl-A の後で 2 を押します。ここで、2 は screen セッションのラベルです。Ctrl-A の後で n を押し、次の screen セッションに切り替えることもできます。

   2. Ctrl-C を押し、サービスを終了させます。

   3. 上矢印キーを押し、最後のコマンドを表示させます。

   4. Enter キーを押し、実行します。

7. Swift の CLI でミドルウェアのテストをしてください。shell の screen セッションに切り替えてテストを開始し、swift の screen セッションにもどってログ出力をチェックして終了します。

   1. Ctrl-A の後で 0 を押します。

   2. cd ~/devstack

   3. source openrc

   4. swift post middleware-test

   5. Ctrl-A の後で 2 を押します。

8. ログの中に以下の行があるでしょう。

   proxy-server ... IPWhitelistMiddleware
   proxy-server Remote IP: 203.0.113.68 (txn: ...)
   proxy-server Allow IPs: set(['203.0.113.68']) (txn: ...)

   基本的に、最初の３行はこのミドルウェアが Swift の他のサービスとやりとりする際に、再度認証を行う必要がないことを示しています。最後の２行は、このミドルウェアによって出力されており、リクエストが DevStack インスタンスから送られており、許可されていることを示しています。

9.  

   DevStack 環境の外の、DevStack 用インスタンスにアクセス可能なリモートマシンからミドルウェアをテストします。

   1. swift --os-auth-url=http://203.0.113.68:5000/v2.0/ --os-region-name=RegionOne --os-username=demo:demo --os-password=devstack list middleware-test

   2. Container GET failed: http://203.0.113.68:8080/v1/AUTH_.../middleware-test?format=json 403 Forbidden   You shall not pass!

10. 再び Swift のログをチェックすると、以下の行が見つかるでしょう。

    proxy-server Invalid user token - deferring reject downstream
    proxy-server Authorizing from an overriding middleware (i.e: tempurl) (txn: ...)
    proxy-server ... IPWhitelistMiddleware
    proxy-server Remote IP: 198.51.100.12 (txn: ...)
    proxy-server Allow IPs: set(['203.0.113.68']) (txn: ...)
    proxy-server IP 198.51.100.12 denied access to Account=AUTH_... Container=None. Not in set(['203.0.113.68']) (txn: ...)

    ここで、リモートIPアドレスが、許可されたIPアドレスの中になかったため、リクエストが拒否されていることがわかります。

11. DevStack用インスタンスに戻り、リモートマシンからのリクエストを許可するようなコンテナのメタデータを追加します。

    1. Ctrl-A の後で 0 を押します。

    2. swift post --meta allow-dev:198.51.100.12 middleware-test

12. ステップ 9 に記載したコマンドをもう一度試すと、今度は成功します。

スケジューラーを作成して、設定を通して組み込むためには：

1. OpenStack のコードは /opt/stack にあるので、nova ディレクトリに移動してあなたのスケジューラーモジュールを編集します。

   1. cd /opt/stack/nova

   2. vim nova/scheduler/ip_scheduler.py

2. 以下のコードをコピーしてください。作業が終わったら、ファイルを保存して閉じてください。

   # vim: tabstop=4 shiftwidth=4 softtabstop=4
   # Copyright (c) 2013 OpenStack Foundation
   # All Rights Reserved.
   #
   #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   #    not use this file except in compliance with the License. You may obtain
   #    a copy of the License at
   #
   #   http://www.apache.org/licenses/LICENSE-2.0
   #
   #    Unless required by applicable law or agreed to in writing, software
   #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   #    License for the specific language governing permissions and limitations
   #    under the License.
   
   """
   IP Scheduler implementation
   """
   
   import random
   
   from nova import exception
   from nova.openstack.common import log as logging
   from nova import flags
   from nova.scheduler import driver
   
   FLAGS = flags.FLAGS
   LOG = logging.getLogger(__name__)
   
   
   class IPScheduler(driver.Scheduler):
       """
       Implements Scheduler as a random node selector based on
       IP address and hostname prefix.
       """
   
       def _filter_hosts(self, hosts, hostname_prefix):
           """Filter a list of hosts based on hostname prefix."""
   
           hosts = [host for host in hosts if host.startswith(hostname_prefix)]
           return hosts
   
       def _schedule(self, context, topic, request_spec, filter_properties):
           """
           Picks a host that is up at random based on
           IP address and hostname prefix.
           """
   
           elevated = context.elevated()
           hosts = self.hosts_up(elevated, topic)
   
           if not hosts:
               msg = _("Is the appropriate service running?")
               raise exception.NoValidHost(reason=msg)
   
           remote_ip = context.remote_address
   
           if remote_ip.startswith('10.1'):
               hostname_prefix = 'doc'
           elif remote_ip.startswith('10.2'):
               hostname_prefix = 'ops'
           else:
               hostname_prefix = 'dev'
   
           hosts = self._filter_hosts(hosts, hostname_prefix)
           host = hosts[int(random.random() * len(hosts))]
   
           LOG.debug(_("Request from %(remote_ip)s scheduled to %(host)s")
                     % locals())
   
           return host
   
       def schedule_run_instance(self, context, request_spec,
                                 admin_password, injected_files,
                                 requested_networks, is_first_time,
                                 filter_properties):
           """Attempts to run the instance"""
           instance_uuids = request_spec.get('instance_uuids')
           for num, instance_uuid in enumerate(instance_uuids):
               request_spec['instance_properties']['launch_index'] = num
               try:
                   host = self._schedule(context, 'compute', request_spec,
                                         filter_properties)
                   updated_instance = driver.instance_update_db(context,
                                                                instance_uuid)
                   self.compute_rpcapi.run_instance(context,
                                                    instance=updated_instance, host=host,
                                                    requested_networks=requested_networks,
                                                    injected_files=injected_files,
                                                    admin_password=admin_password,
                                                    is_first_time=is_first_time,
                                                    request_spec=request_spec,
                                                    filter_properties=filter_properties)
               except Exception as ex:
                   # NOTE(vish): we don't reraise the exception here to make sure
                   # that all instances in the request get set to
                   # error properly
                   driver.handle_schedule_error(context, ex, instance_uuid,
                                            request_spec)
   
       def schedule_prep_resize(self, context, image, request_spec,
                                filter_properties, instance, instance_type,
                                reservations):
           """Select a target for resize."""
           host = self._schedule(context, 'compute', request_spec,
                                 filter_properties)
           self.compute_rpcapi.prep_resize(context, image, instance,
                                           instance_type, host, reservations)
   

   context と request_spec と filter_propertiesには、どこにインスタンスをスケジュールするのか決定するのに使える有用な情報が多数含まれています。どんなプロパティが利用可能なのかを知るには、以下のログ出力文を上記の schedule_run_instance メソッドに挿入してください。

   LOG.debug(_("context = %(context)s") % {'context': context.__dict__})LOG.debug(_("request_spec = %(request_spec)s") % locals())LOG.debug(_("filter_properties = %(filter_properties)s") % locals())

3. このスケジューラーを Nova に組み込むには、設定ファイルを1つ編集する必要があります。

   LOG$ vim /etc/nova/nova.conf

4. compute_scheduler_driver 設定を見つけ、このように変更してください。

   LOGcompute_scheduler_driver=nova.scheduler.ip_scheduler.IPScheduler

5. Nova にこのスケジューラーを使わせるために、Nova スケジューラーサービスを再起動します。 n-sch screen セッションに切り替えてはじめてください。

   1. Ctrl-A の後で 8 を押します。

   2. Ctrl-C を押し、サービスを終了させます。

   3. 上矢印キーを押し、最後のコマンドを表示させます。

   4. Enter キーを押し、実行します。

6. Nova の CLI でスケジューラーのテストをしてください。shell の screen セッションに切り替えてテストを開始し、n-sch screen セッションにもどってログ出力をチェックして終了します。

   1. Ctrl-A の後で 0 を押します。

   2. cd ~/devstack

   3. source openrc

   4. IMAGE_ID=`nova image-list | egrep cirros | egrep -v "kernel|ramdisk" | awk '{print $2}'`

   5. nova boot --flavor 1 --image $IMAGE_ID scheduler-test

   6. Ctrl-A の後で 8 を押します。

7. ログの中に以下の行があるでしょう。

   LOG2013-02-27 17:39:31 DEBUG nova.scheduler.ip_scheduler [req-... demo demo] Request from 50.56.172.78 scheduled to
   devstack-nova from (pid=4118) _schedule /opt/stack/nova/nova/scheduler/ip_scheduler.py:73