성능 확장은 총 포드 수를 통해 수행됩니다. 하드웨어 리소스가 많을수록 더 많은 Pod를 배포합니다.

다음 명령을 사용하여 Pod 수를 통해 성능을 확장합니다.

oc scale dc dc-name --replicas=X

3scale을 위해 스케일링할 주요 배포 구성은 다음과 같습니다.

이를 통해 모든 로그가 Elasticsearch, Fluentd 및 Kibana(EFK) 로깅 툴에서 쿼리할 수 있습니다. 이러한 툴을 사용하면 3scale 구성의 변경 사항과 이러한 변경 사항을 언제 변경했는지 파악할 수 있습니다. 예를 들어 청구, 애플리케이션 계획, API 구성 등의 변경 사항이 포함됩니다.

3scale은 features.yml 구성 파일을 사용하여 일부 글로벌 기능을 활성화합니다. stdout 에 감사 로깅을 활성화하려면 ConfigMap 에서 이 파일을 마운트하여 기본 파일을 교체해야 합니다. features.yml 에 종속되는 OpenShift 포드는 system-app 및 system-sidekiq 입니다.

3scale 애플리케이션 로그를 OpenShift로 전달하기 위해 stdout 에 감사 로깅을 활성화한 경우 EFK 로깅 툴을 사용하여 3scale 애플리케이션을 모니터링할 수 있습니다.

OpenShift에서 EFK 로깅을 구성하는 방법에 대한 자세한 내용은 다음을 참조하십시오.

각 구성 요소의 배포 구성에는 액세스 및 예외에 대한 로그가 포함되어 있습니다. 배포에 문제가 발생하면 해당 로그에서 자세한 내용을 확인하십시오.

3scale의 로그에 액세스하려면 다음 단계를 따르십시오.

작업 대기열에는 system-sidekiq 포드에서 전송된 정보의 로그가 포함되어 있습니다. 이 로그를 사용하여 클러스터가 데이터를 처리 중인지 확인합니다. OpenShift CLI를 사용하여 로그를 쿼리할 수 있습니다.

oc get jobs

oc logs <job>

monotonic 증가를 방지하기 위해 기본적으로 3scale 일정으로 다음 테이블을 자동으로 삭제합니다.

위에 나열된 테이블을 제외하고 다음 테이블에는 데이터베이스 관리자가 수동으로 삭제해야 합니다.

DELETE FROM alerts WHERE timestamp < NOW() - INTERVAL 14 DAY;

DELETE FROM alerts WHERE timestamp < NOW() - INTERVAL '14 day';

DELETE FROM alerts WHERE timestamp <= TRUNC(SYSDATE) - 14;

이 섹션에 지정되지 않은 다른 테이블의 경우 데이터베이스 관리자는 시스템이 자동으로 삭제되지 않는 테이블을 수동으로 정리해야 합니다.

이 섹션에서는 toolbox 컨테이너 이미지를 설치하는 방법을 설명합니다.

다음 예제 명령은 <url>에서 짧은 <name> 을 사용하여 원격 3scale 인스턴스를 추가합니다.

3scale remote add [--config-file <config_file>] <name> <url>

$ podman run --name toolbox-container registry.redhat.io/3scale-amp2/toolbox-rhel8:3scale2.13 3scale remote add instance_a https://123456789@example_a.net

$ podman commit toolbox-container toolbox

이 예제에서는 원격 인스턴스를 생성하고 컨테이너를 커밋하여 새 이미지를 생성합니다. 그런 다음 원격 정보가 포함된 새 이미지를 실행할 수 있습니다. 예를 들어 다음 명령은 새 이미지를 사용하여 새로 추가된 원격 을 표시합니다.

$ podman run toolbox 3scale remote list
instance_a https://example_a.net 123456789

그런 다음 기타 toolbox 명령은 새로 생성된 이미지를 사용하여 추가된 원격에 액세스할 수 있습니다. 이 예에서는 registry.redhat.io/3scale-amp2/ toolbox -rhel8:3scale2.13 대신 toolbox 라는 이미지를 사용합니다.

다음 예제 명령은 원격 액세스 자격 증명을 나열하는 방법을 보여줍니다.

3scale remote list [--config-file <config_file>]

이 명령은 추가된 원격 3scale 인스턴스 목록을 <name> <URL&gt; < authentication-key> 형식으로 표시합니다.

$ podman run <toolbox_image_with_remotes_added> 3scale remote list
instance_a https://example_a.net 123456789
instance_b https://example_b.net 987654321

다음 예제 명령은 원격 액세스 자격 증명을 제거하는 방법을 보여줍니다.

3scale remote remove [--config-file <config_file>] <name>

이 명령은 짧은 <name>:이 명령을 사용하여 원격 3scale 인스턴스를 제거합니다.

$ podman run <toolbox_image_with_remote_added> 3scale remote remove instance_a

다음 예제 명령은 원격 액세스 자격 증명의 이름을 변경하는 방법을 보여줍니다.

3scale remote rename [--config-file <config_file>] <old_name> <new_name>

이 명령은 짧은 <old_name>을 사용하여 원격 3scale 인스턴스의 이름을 < new_name> 으로 변경합니다.

$ podman run <toolbox_image_with_remote_added> 3scale remote rename instance_a instance_b

다음 단계를 사용하여 새 애플리케이션 계획을 생성합니다.

다음 명령은 새 애플리케이션 계획을 생성합니다.

3scale application-plan create [opts] <remote> <service> <plan-name>

애플리케이션 계획을 생성하는 동안 다음 옵션을 사용합니다.

Options
       --approval-required=<value>    The application requires approval:
                                      true or false
       --cost-per-month=<value>       Cost per month
       --default                      Make the default application plan
       --disabled                     Disable all methods and metrics in
                                      the application plan
    -o --output=<value>               Output format on stdout:
                                      one of json|yaml
    -p --published                    Publish the application plan
       --setup-fee=<value>            Set-up fee
    -t --system-name=<value>          Set application plan system name
       --trial-period-days=<value>    The trial period in days

Options for application-plan
    -c --config-file=<value>          3scale toolbox configuration file:
                                      defaults to $HOME/.3scalerc.yaml
    -h --help                         Print help for this command
    -k --insecure                     Proceed and operate even for server
                                      connections otherwise considered
                                      insecure
    -v --version                      Print the version of this command
       --verbose                      Verbose mode

다음 단계를 사용하여 새 애플리케이션 계획이 없는 경우 애플리케이션을 생성하거나 기존 애플리케이션 계획을 업데이트합니다.

다음 명령은 애플리케이션 계획을 업데이트합니다.

3scale application-plan create [opts] <remote> <service> <plan>

애플리케이션 계획을 업데이트하는 동안 다음 옵션을 사용합니다.

Options
       --approval-required=<value>    The application requires approval:
                                      true or false
       --cost-per-month=<value>       Cost per month
       --default                      Make the default application plan
       --disabled                     Disable all methods and metrics in
                                      the application plan
       --enabled                      Enable the application plan
       --hide                         Hide the application plan
    -n --name=<value>                 Set the plan name
    -o --output=<value>               Output format on stdout:
                                      one of json|yaml
    -p --publish                      Publish the application plan
       --setup-fee=<value>            Set-up fee
       --trial-period-days=<value>    The trial period in days

Options for application-plan
    -c --config-file=<value>          3scale toolbox configuration file:
                                      defaults to $HOME/.3scalerc.yaml
    -h --help                         Print help for this command
    -k --insecure                     Proceed and operate even for server
                                      connections otherwise considered
                                      insecure
    -v --version                      Print the version of this command
       --verbose                      Verbose mode

다음 명령은 애플리케이션 계획을 나열합니다.

3scale application-plan list [opts] <remote> <service>

애플리케이션 계획을 나열하는 동안 다음 옵션을 사용합니다.

Options
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for application-plan
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 애플리케이션 계획을 보여줍니다.

3scale application-plan show [opts] <remote> <service> <plan>

애플리케이션 계획을 보여주는 동안 다음 옵션을 사용합니다.

Options
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for application-plan
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 애플리케이션 계획을 삭제합니다.

3scale application-plan delete [opts] <remote> <service> <plan>

애플리케이션 계획을 삭제하는 동안 다음 옵션을 사용합니다.

Options for application-plan
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

단일 애플리케이션 계획을 yaml 콘텐츠로 내보내거나 가져올 수 있습니다.

다음을 확인합니다.

3scale application-plan export [opts] <remote> <service_system_name> <plan_system_name>

$ podman run -u root -v $PWD:/tmp registry.redhat.io/3scale-amp2/toolbox-rhel8:3scale2.13 3scale application-plan export --file=/tmp/plan.yaml remote_name service_name plan_name

Options
    -f --file=<value>             Write to file instead of stdout

Options for application-plan
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

3scale application-plan import [opts] <remote> <service_system_name>

$ podman run -v $PWD/plan.yaml:/tmp/plan.yaml registry.redhat.io/3scale-amp2/toolbox-rhel8:3scale2.13 3scale application-plan import --file=/tmp/plan.yaml remote_name service_name

3scale application-plan import -f http[s]://domain/resource/path.yaml remote_name service_name

Options
    -f --file=<value>                  Read from file or URL instead of
                                       stdin
    -p --plan=<value>                  Override application plan reference

Options for application-plan
    -c --config-file=<value>           3scale toolbox configuration file:
                                       defaults to $HOME/.3scalerc.yaml
    -h --help                          Print help for this command
    -k --insecure                      Proceed and operate even for server
                                       connections otherwise considered
                                       insecure
    -v --version                       Print the version of this command
       --verbose                       Verbose mode

다음 단계를 사용하여 새 메트릭이 없는 경우 해당 지표를 생성하거나 기존 지표를 업데이트합니다.

다음 명령 목록은 메트릭을 업데이트합니다.

3scale metric apply [opts] <remote> <service> <metric>

메트릭을 업데이트하는 동안 다음 옵션을 사용합니다.

Options
       --description=<value>      Set a metric description
       --disabled                 Disable this metric in all application
                                  plans
       --enabled                  Enable this metric in all application
                                  plans
    -n --name=<value>             This will set the metric name
       --unit=<value>             Metric unit: default hit
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for metric
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 메트릭을 나열합니다.

3scale metric list [opts] <remote> <service>

메트릭을 나열하는 동안 다음 옵션을 사용합니다.

Options
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for metric
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 메트릭을 삭제합니다.

3scale metric delete [opts] <remote> <service> <metric>

메트릭을 삭제하는 동안 다음 옵션을 사용합니다.

Options for metric
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

방법을 생성하려면 다음 단계를 사용하십시오.

다음 명령은 메서드를 생성합니다.

3scale method create [opts] <remote> <service> <method-name>

방법을 생성하는 동안 다음 옵션을 사용합니다.

Options
       --description=<value>      Set a method description
       --disabled                 Disable this method in all
                                  application plans
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml
    -t --system-name=<value>      Set the method system name

Options for method
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

새로운 메서드가 없는 경우 새 메서드를 생성하거나 기존 메서드를 업데이트하려면 아래 단계를 사용합니다.

다음 명령은 메서드를 업데이트합니다.

3scale method apply [opts] <remote> <service> <method>

방법을 업데이트하는 동안 다음 옵션을 사용합니다.

Options
       --description=<value>      Set a method description
       --disabled                 Disable this method in all
                                  application plans
       --enabled                  Enable this method in all
                                  application plans
    -n --name=<value>             Set the method name
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for method
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 메서드를 나열합니다.

3scale method list [opts] <remote> <service>

방법을 나열하는 동안 다음 옵션을 사용합니다.

Options
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for method
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 메서드를 삭제합니다.

3scale method delete [opts] <remote> <service> <metric>

방법을 삭제하는 동안 다음 옵션을 사용합니다.

Options for method
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 새 서비스를 생성합니다.

3scale service create [options] <remote> <service-name>

서비스를 생성하는 동안 다음 옵션을 사용합니다.

Options
    -a --authentication-mode=<value>     Specify authentication mode of
                                         the service:
                                          - '1' for API key
                                          - '2' for App Id/App Key
                                          - 'oauth' for OAuth mode
                                          - 'oidc' for OpenID Connect
    -d --deployment-mode=<value>         Specify the deployment mode of
                                         the service
       --description=<value>             Specify the description of the
                                         service
    -o --output=<value>                  Output format on stdout:
                                         one of json|yaml
    -s --system-name=<value>             Specify the system-name of the
                                         service
       --support-email=<value>           Specify the support email of the
                                         service

Options for service
    -c --config-file=<value>             3scale toolbox configuration file:
                                         defaults to $HOME/.3scalerc.yaml
    -h --help                            Print help for this command
    -k --insecure                        Proceed and operate even for
                                         server connections otherwise
                                         considered insecure
    -v --version                         Print the version of this command
       --verbose                         Verbose mode

다음을 사용하여 새 서비스를 생성하거나 기존 서비스를 업데이트합니다.

다음 명령은 서비스를 업데이트합니다.

3scale service apply <remote> <service-id_or_system-name>

서비스를 업데이트하는 동안 다음 옵션을 사용합니다.

Options
    -a --authentication-mode=<value>     Specify authentication mode of
                                         the service:
                                           - '1' for API key
                                           - '2' for App Id/App Key
                                           - 'oauth' for OAuth mode
                                           - 'oidc' for OpenID Connect
    -d --deployment-mode=<value>         Specify the deployment mode of
                                         the service
       --description=<value>             Specify the description of the
                                         service
    -n --name=<value>                    Specify the name of the metric
       --support-email=<value>           Specify the support email of the
                                         service
    -o --output=<value>                  Output format on stdout:
                                         one of json|yaml

Options for services
    -c --config-file=<value>             3scale toolbox configuration file:
                                         defaults to $HOME/.3scalerc.yaml
    -h --help                            Print help for this command
    -k --insecure                        Proceed and operate even for
                                         server connections otherwise
                                         considered insecure
    -v --version                         Print the version of this command
       --verbose                         Verbose mode

다음 명령은 서비스를 나열합니다.

3scale service list <remote>

서비스를 나열하는 동안 다음 옵션을 사용합니다.

Options
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for services
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 서비스를 표시합니다.

3scale service show <remote> <service-id_or_system-name>

서비스를 보여주는 동안 다음 옵션을 사용합니다.

Options
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for services
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 서비스를 삭제합니다.

3scale service delete <remote> <service-id_or_system-name>

서비스를 삭제하는 동안 다음 옵션을 사용합니다.

Options for services
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

OpenAPI 사양과 호환되는 API 정의에서 새 ActiveDocs를 생성하려면 다음을 수행합니다.

다음 명령을 사용하여 새 ActiveDocs가 없는 경우 새로 생성하거나 기존 ActiveDocs를 새 API 정의로 업데이트합니다.

3scale activedocs apply <remote> <activedocs_id_or_system_name>

ActiveDocs를 업데이트하는 동안 다음 옵션을 사용하십시오.

Options
  -d --description=<value>              Specify the description of the
                                        ActiveDocs
       --hide                           Specify to hide the ActiveDocs
                                        on the Developer Portal
 -i --service-id=<value>                Specify the Service ID associated
                                        to the ActiveDocs
 -o --output=<value>                    Output format on stdout:
                                        one of json|yaml
    --openapi-spec=<value>              Specify the Swagger specification.
                                        Can be a file, a URL or '-' to read
                                        from stdin. This is a mandatory
                                        option when applying the ActiveDoc
                                        for the first time.
 -p --publish                           Specify to publish the ActiveDocs
                                        on the Developer Portal. Otherwise
                                        it is hidden
 -s --name=<value>                      Specify the name of the ActiveDocs
    --skip-swagger-validations=<value>  Specify whether to skip validation
                                        of the Swagger specification: true
                                        or false. Defaults to true.

Options for ActiveDocs
    -c --config-file=<value>           3scale toolbox configuration file:
                                       defaults to $HOME/.3scalerc.yaml
    -h --help                          Print help for this command
    -k --insecure                      Proceed and operate even for server
                                       connections otherwise considered
                                       insecure
    -v --version                       Print the version of this command
       --verbose                       Verbose mode

다음 명령을 사용하여 다음을 포함하여 개발자 포털의 모든 ActiveDocs에 대한 정보를 가져옵니다.

다음 명령은 정의된 모든 ActiveDocs를 나열합니다.

3scale activedocs list <remote>

ActiveDocs를 나열하는 동안 다음 옵션을 사용하십시오.

Options
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml
    -s --service-ref=<value>      Filter the ActiveDocs by service
                                  reference
Options for ActiveDocs
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 ActiveDocs를 제거합니다.

3scale activedocs delete <remote> <activedocs-id_or-system-name>

ActiveDocs를 삭제하는 동안 다음 옵션을 사용하십시오.

Options for ActiveDocs
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 프록시 구성을 표시합니다.

3scale proxy-config show <remote> <service> <environment>

프록시 구성을 표시하는 동안 다음 옵션을 사용합니다.

Options
       --config-version=<value>   Specify the proxy configuration version.
                                  If not specified, defaults to latest
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

Options for proxy-config
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered
                                  insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 최신 스테이징 프록시 구성을 프로덕션 환경으로 승격합니다.

3scale proxy-config promote <remote> <service>

최신 스테이징 프록시 구성을 프로덕션 환경으로 승격하는 동안 다음 옵션을 사용합니다.

Options for proxy-config
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

예를 들어, 3scale 인스턴스에 연결되어 있지 않은 자체 관리 APIcast 게이트웨이가 있는 경우 proxy-config export 명령을 사용합니다. 이 시나리오에서는 수동으로 또는 API 배포 및 구성 옵션을 사용하여 3scale 구성을 삽입합니다. 두 경우 모두 3scale 구성을 제공해야 합니다.

다음 명령은 APIcast 게이트웨이에 삽입할 수 있는 구성을 내보냅니다.

3scale proxy-config export <remote>

3scale 구성 파일로 사용할 공급자 계정의 프록시 구성을 내보낼 때 다음 옵션을 지정할 수 있습니다.

Options for proxy-config
--environment=<value>      Gateway environment. Must be 'sandbox' or
                           'production' (default: sandbox)
-o --output=<value>        Output format. One of: json|yaml

다음 배포 명령은 서비스 메시를 사용하는 경우 APIcast 구성을 3scale의 스테이징 환경 또는 프로덕션 환경으로 승격합니다.

3scale proxy deploy <remote> <service>

deploy 명령을 사용하여 APIcast 구성을 스테이징 환경으로 승격할 때 다음 옵션을 지정할 수 있습니다.

-o --output=<value>        Output format. One of: json|yaml

다음 update 명령은 APIcast 구성을 업데이트합니다.

3scale proxy update <remote> <service>

update 명령을 사용하여 APIcast 구성을 업데이트할 때 다음 옵션을 지정할 수 있습니다.

-o --output=<value>           Output format. One of: json|yaml
-p --param=<value>            APIcast configuration parameters. Format:
                              [--param key=value]. Multiple options allowed.

다음 show 명령은 배포 취소된 APIcast 구성을 가져옵니다.

3scale proxy show <remote> <service>

show 명령을 사용하는 경우 다음 옵션을 지정하여 배포 취소된 APIcast 구성을 가져올 수 있습니다.

-o --output=<value>           Output format. One of: json|yaml

다음 배포 명령은 서비스 메시를 사용하는 경우 APIcast 구성을 3scale의 스테이징 환경 또는 프로덕션 환경으로 승격합니다.

3scale proxy-config deploy <remote> <service>

deploy 명령을 사용하여 APIcast 구성을 스테이징 환경으로 승격할 때 다음 옵션을 지정할 수 있습니다.

-o --output=<value>        Output format. One of: json|yaml

create 명령을 사용하여 지정된 3scale 계정 및 애플리케이션 계획에 연결된 하나의 애플리케이션을 만듭니다.

다음 명령은 애플리케이션을 생성합니다.

3scale application create [opts] <remote> <account> <service> <application-plan> <name>

애플리케이션을 생성하는 동안 다음 옵션을 사용합니다.

OPTIONS
       --application-id=<value>     App ID or Client ID (for OAuth and
                                    OpenID Connect authentication modes)
                                    of the application to be created.
       --application-key=<value>    App Key(s) or Client Secret (for OAuth
                                    and OpenID Connect authentication
                                    modes) of the application created.
       --description=<value>        Application description
    -o --output=<value>             Output format on stdout:
                                    one of json|yaml
       --redirect-url=<value>       OpenID Connect redirect url
       --user-key=<value>           User Key (API Key) of the application
                                    to be created.

OPTIONS FOR APPLICATION
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령은 애플리케이션을 보여줍니다.

3scale application show [opts] <remote> <application>

OPTIONS
    -o --output=<value>           Output format on stdout:
                                  one of json|yaml

OPTIONS FOR APPLICATION
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Print help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode

다음 명령을 사용하여 새 애플리케이션이 없는 경우 애플리케이션을 생성하거나 기존 애플리케이션을 업데이트합니다.

3scale application apply [opts] <remote> <application>

애플리케이션을 업데이트하는 동안 다음 옵션을 사용합니다.

OPTIONS
       --account=<value>           Application's account. Required when
                                   creating
       --application-key=<value>   App Key(s) or Client Secret (for OAuth
                                   and OpenID Connect authentication
                                   modes) of the application to be
                                   created. Only used when application
                                   does not exist.
       --description=<value>       Application description
       --name=<value>              Application name
    -o --output=<value>            Output format on stdout:
                                   one of json|yaml
       --plan=<value>              Application's plan. Required when
                                   creating.
       --redirect-url=<value>      OpenID Connect redirect url
       --resume                    Resume a suspended application
       --service=<value>           Application's service. Required when
                                   creating.
       --suspend                   Suspends an application (changes the
                                   state to suspended)
       --user-key=<value>          User Key (API Key) of the application
                                   to be created.

OPTIONS FOR APPLICATION
    -c --config-file=<value>      3scale toolbox configuration file:
                                  defaults to $HOME/.3scalerc.yaml
    -h --help                     Show help for this command
    -k --insecure                 Proceed and operate even for server
                                  connections otherwise considered insecure
    -v --version                  Print the version of this command
       --verbose                  Verbose mode.

다음 명령은 애플리케이션을 삭제합니다.

3scale application delete [opts] <remote> <application>

이 방법에서는 각 API 백엔드 환경에 별도의 3scale 인스턴스가 배포됩니다. 이 아키텍처의 이점은 각 환경이 서로 격리되므로 공유 데이터베이스 또는 기타 리소스가 없다는 것입니다. 예를 들어 한 환경에서 수행되는 모든 부하 테스트는 다른 환경의 리소스에 영향을 주지 않습니다.

이 방법에서는 단일 3scale 인스턴스가 사용되지만 멀티 테넌시 기능은 여러 API 백엔드를 지원하는 데 사용됩니다.

APIcast 내장 게이트웨이를 사용하면 API cast 게이트웨이와 함께 3scale에 설명된 위의 방식으로 구성된 API 백엔드가 자동으로 처리됩니다. 3scale Master Admin에서 테넌트를 추가하면 프로덕션 및 기본 제공 APIcast 게이트웨이를 스테이징하는 테넌트에 대한 경로가 생성됩니다. 멀티 테넌시 하위 도메인 이해보기

따라서 다른 테넌트에 매핑되는 각 API 백엔드 환경에는 해당 경로가 할당됩니다. 예를 들면 다음과 같습니다.

추가 APIcast 게이트웨이는 3scale 인스턴스가 실행 중인 것과 다른 OpenShift 클러스터에 배포된 게이트웨이입니다. 추가 APIcast 게이트웨이를 설정하고 사용하는 방법은 여러 가지가 있습니다. APIcast를 시작할 때 사용되는 환경 변수 THREESCALE_PORTAL_ENDPOINT 의 값은 추가 APIcast 게이트웨이 설정 방법에 따라 달라집니다.

각 API 백엔드 환경에 별도의 APIcast 게이트웨이를 사용할 수 있습니다. 예를 들면 다음과 같습니다.

DEV_APICAST -> DEV_TENANT ; DEV_APICAST started with THREESCALE_PORTAL_ENDPOINT = admin portal for DEV_TENANT
QA_APICAST -> QA_TENANT ; QA_APICAST started with THREESCALE_PORTAL_ENDPOINT = admin portal for QA_APICAST
PROD_APICAST -> PROD_TENANT ; PROD_APICAST started with THREESCALE_PORTAL_ENDPOINT = admin portal for PROD_APICAST

THREESCALE_PORTAL_ENDPOINT 는 APIcast에서 구성을 다운로드하는 데 사용됩니다. API 백엔드 환경에 매핑되는 각 테넌트는 별도의 APIcast 게이트웨이를 사용합니다. THREESCALE_PORTAL_ENDPOINT 는 해당 API 백엔드 환경과 관련된 모든 제품 구성을 포함하는 테넌트의 관리 포털로 설정됩니다.

단일 APIcast 게이트웨이를 여러 API 백엔드 환경에서 사용할 수 있습니다. 이 경우 THREESCALE_PORTAL_ENDPOINT 가 Master Admin Portal 로 설정됩니다.

API 프로바이더 사이클 단계는 API 지정, 개발 및 배포를 기반으로 합니다. 다음은 각 단계의 목표와 결과를 설명합니다.

API 소비자 사이클 단계는 사용을 위해 API를 승격, 배포 및 재설정하는 방법을 기반으로 합니다. 다음은 각 단계의 목표와 결과를 설명합니다.

다음 샘플은 API 라이프사이클 자동화를 위해 Jenkins 파이프라인을 생성하고 배포하는 방법에 대한 예로 Red Hat 통합 리포지토리에 제공됩니다.

이러한 샘플은 3scale 툴박스를 호출하여 주요 API 관리 기능을 보여주는 3scale Jenkins 공유 라이브러리를 사용합니다. 이 항목에서 설정 단계를 수행한 후 Red Hat 통합 리포지토리의 각 샘플 사용 사례에 제공된 OpenShift 템플릿을 사용하여 파이프라인을 설치할 수 있습니다.

3scale 호스팅 환경 설정은 모든 샘플 Jenkins CI/CD 파이프라인에 필요합니다.

3scale 온프레미스 환경 설정은 하이브리드( 오픈 및 하이브리드) - OIDC 샘플 Jenkins CI/CD 파이프라인에만 필요합니다.

Hybrid - OpenID Connect (OIDC) 또는 Semantic 버전 지정 샘플 파이프라인을 사용하는 경우 이 섹션의 단계를 수행하여 3scale로 RH-SSO(Red Hat Single Sign-On)를 배포합니다. 이는 두 샘플 모두에서 사용되는 OIDC 인증에 필요합니다.

이 섹션에서는 toolbox를 설치하고, 원격 3scale 인스턴스를 생성하며, 관리 포털에 액세스하는 데 사용되는 시크릿을 프로비저닝하는 방법을 설명합니다.

이 섹션에서는 샘플 파이프라인과 함께 제공되는 예제 API 백엔드를 배포하는 방법을 보여줍니다. 자체 파이프라인을 생성 및 배포할 때 필요에 따라 자체 API 백엔드를 교체할 수 있습니다.

이 섹션은 3scale 호스팅 환경에서 APIcast 자체 관리 인스턴스에 사용하기 위한 것입니다. SaaS - API 키를 제외한 모든 샘플 파이프라인에 적용됩니다.

필수 환경을 설정한 후에는 Red Hat 통합 리포지토리의 각 샘플 사용 사례에 제공된 OpenShift 템플릿을 사용하여 샘플 파이프라인을 설치하고 배포할 수 있습니다. 예를 들어 이 섹션에는 SaaS - API Key 샘플만 표시됩니다.

이 릴리스에서는 다음과 같은 제한 사항이 적용됩니다.

3scale 백엔드 및 제품을 만들 수 있도록 OpenAPI CR(사용자 정의 리소스)을 배포합니다.

OpenAPI CRD(사용자 정의 리소스 정의) 배포 기능에 대한 지식은 3scale 제품, 백엔드 및 후속 개발자 포털을 위한 ActiveDocs를 구성하는 데 도움이 됩니다.

가져오기 규칙은 3scale 배포에 대한 OpenAPI 문서를 설정할 때 OAS(OpenAPI Specification)가 3scale에서 작동하는 방식을 지정합니다.

OpenAPI 문서에서 paths 오브젝트는 동사 및 패턴 속성에 대한 매핑 규칙을 제공합니다. 3scale 메서드는 이에 따라 operationId 에 연결됩니다.

delta 값은 1 로 하드 코딩됩니다.

기본적으로 Strict 일치하는 정책이 구성됩니다. OpenAPI CRD의 spec.PrefixMatching 필드를 사용하여 일치 정책을 Prefix 일치 로 전환할 수 있습니다.

지원되는 보안 스키마는 apiKey 입니다.

apiKey 보안 스키마 유형:

다음은 apiKey 보안 요구 사항이 있는 OAS 3.0.2의 일부 예입니다.

openapi: "3.0.2"
security:
  - petstore_api_key: []
components:
  securitySchemes:
    petstore_api_key:
      type: apiKey
      name: api_key
      in: header

OpenAPI 문서가 보안 요구 사항을 지정하지 않으면 다음 사항이 적용됩니다.

3scale 인증 보안은 spec.privateAPIHostHeader 및 OpenAPI CRD의 spec.privateAPISecretToken 필드를 사용하여 설정할 수 있습니다.

사용자 정의 공개 기본 URL이 있는 OpenAPI CR의 예:

apiVersion: capabilities.3scale.net/v1beta1
kind: OpenAPI
metadata:
  name: openapi1
spec:
  openapiRef:
    url: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml"
  productionPublicBaseURL: "https://production.my-gateway.example.com"
  stagingPublicBaseURL: "https://staging.my-gateway.example.com"

사용자가 지정한 URL에서 OAS 문서를 가져오는 OpenAPI 사용자 지정 리소스를 배포할 수 있습니다. 그런 다음 이 OAS 문서를 개발자 포털에서 API의 ActiveDocs의 기반으로 사용할 수 있습니다.

3scale 백엔드 및 제품을 생성할 수 있도록 ActiveDoc CR(사용자 정의 리소스)을 배포합니다.

ActiveDoc CRD(사용자 정의 리소스 정의)는 개발자를 위한 OpenAPI 문서 형식의 제품 문서에 관한 것입니다. ActiveDoc CRD 배포 기능에 대한 지식이 있으면 개발자 포털용 ActiveDocs를 생성할 수 있습니다.

지정하는 URL에서 OAS(OpenAPI Specification) 문서를 가져오는 ActiveDoc CR(사용자 정의 리소스)을 배포할 수 있습니다. 그런 다음 이 OAS 문서를 개발자 포털에서 API의 ActiveDocs의 기반으로 사용할 수 있습니다.

새로 생성된 테넌트에서 Openshift Container Platform을 사용하여 새 백엔드를 구성합니다.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 백엔드 사용자 정의 리소스에서 원하는 백엔드 지표를 정의합니다.

다음 관찰을 고려하십시오.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 백엔드 사용자 정의 리소스에 원하는 백엔드 메서드를 정의합니다.

다음 관찰을 고려하십시오.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 백엔드 사용자 정의 리소스에 원하는 백엔드 매핑 규칙을 정의합니다.

다음 관찰을 고려하십시오.

status 필드에는 최종 사용자에게 유용한 리소스 정보가 표시됩니다. 수동으로 업데이트하려는 것은 아니며 리소스 변경 시 동기화됩니다.

다음은 status 필드의 속성입니다.

동기화된 리소스의 예:

status:
    backendId: 59978
    conditions:
    - lastTransitionTime: "2020-06-22T10:50:33Z"
      status: "False"
      type: Failed
    - lastTransitionTime: "2020-06-22T10:50:33Z"
      status: "False"
      type: Invalid
    - lastTransitionTime: "2020-06-22T10:50:33Z"
      status: "True"
      type: Synced
    observedGeneration: 2

3scale Operator가 새로운 3scale 리소스를 찾으면 LookupProviderAccount 프로세스는 리소스를 소유한 테넌트를 식별하기 위한 목적으로 시작됩니다.

이 프로세스는 테넌트 자격 증명 소스를 확인합니다. 찾을 수 없는 경우 오류가 발생합니다.

다음 단계에서는 프로세스가 테넌트 자격 증명 소스를 확인하는 방법을 설명합니다.

관리하는 백엔드 사용자 정의 리소스(CR)를 삭제 하여 백엔드 엔터티를 삭제할 수 있습니다. 백엔드 CR을 삭제하면 3scale Operator가 삭제된 백엔드를 참조하는 제품 CR을 업데이트합니다. 업데이트는 다음 특성에 있습니다.

이러한 속성은 더 이상 삭제된 백엔드를 참조하지 않습니다.

새로 생성된 테넌트에서 Openshift Container Platform을 사용하여 신제품을 구성합니다.

apiVersion: capabilities.3scale.net/v1beta1
kind: Product
metadata:
  name: product1
spec:
  name: "OperatedProduct 1"
  deployment:
    apicastHosted: {}

apiVersion: capabilities.3scale.net/v1beta1
kind: Product
metadata:
  name: product1
spec:
  name: "OperatedProduct 1"
  deployment:
    apicastSelfManaged:
      stagingPublicBaseURL: "https://staging.api.example.com"
      productionPublicBaseURL: "https://production.api.example.com"

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 application Plans 오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 애플리케이션 계획을 정의합니다.

다음 관찰을 고려하십시오.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 application Plans.limits 목록을 사용하여 제품 애플리케이션 계획에 필요한 제한을 정의합니다.

다음 관찰을 고려하십시오.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 application Plans.pricingRules 목록을 사용하여 제품 애플리케이션 계획에 필요한 가격 규칙을 정의합니다.

다음 관찰을 고려하십시오.

OAuth 2.0 흐름에 대한 인증에 OIDC (OpenID Connect )를 사용하는 3scale 제품에 대한 제품 사용자 지정 리소스를 배포할 수 있습니다. 3scale은 OpenID Connect와 같은 타사 IdM(Identity Providers)과 통합되어 API 요청을 인증합니다. OpenID Connect에 대한 자세한 내용은 OpenID Connect 통합을 참조하십시오. 타사 IdP와 통합한 후 제품 사용자 정의 리소스에 포함할 두 가지 유형의 데이터를 보유하게 됩니다.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 지표 오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 지표를 정의합니다.

다음 관찰을 고려하십시오.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 메서드 오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 방법을 정의합니다.

다음 관찰을 고려하십시오.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 mappingRules 오브젝트를 사용하여 제품 사용자 정의 리소스에 원하는 매핑 규칙을 정의합니다.

다음 관찰을 고려하십시오.

새로 생성된 3scale 테넌트와 함께 Openshift Container Platform을 사용하여 backendUsages 오브젝트를 적용하여 제품 선언적으로 원하는 백엔드를 정의합니다.

다음 관찰을 고려하십시오.

3scale 관리자는 제품 사용자 지정 리소스를 구성하여 해당 API 제품에 대해 노출된 API 요청에 대한 게이트웨이 응답을 지정할 수 있습니다. CR을 배포한 후 3scale은 사용자가 지정한 응답 및 오류 메시지를 반환하도록 합니다.

Product CR에서 gatewayResponse 오브젝트에는 게이트웨이가 반환할 응답이 포함되어 있습니다.

3scale 관리자는 제품 사용자 지정 리소스를 구성하여 해당 API 제품에 적용할 정책 체인을 지정할 수 있습니다. CR을 배포한 후 3scale은 구성된 정책을 제품의 업스트림, 노출된 API에 적용합니다.

status 필드에는 최종 사용자에게 유용한 리소스 정보가 표시됩니다. 수동으로 업데이트하려는 것은 아니며 리소스 변경 시 동기화됩니다.

다음은 status 필드의 속성입니다.

동기화된 리소스의 예:

status:
  conditions:
  - lastTransitionTime: "2020-10-21T18:07:01Z"
    status: "False"
    type: Failed
  - lastTransitionTime: "2020-10-21T18:06:54Z"
    status: "False"
    type: Invalid
  - lastTransitionTime: "2020-10-21T18:07:01Z"
    status: "False"
    type: Orphan
  - lastTransitionTime: "2020-10-21T18:07:01Z"
    status: "True"
    type: Synced
  observedGeneration: 1
  productId: 2555417872138
  providerAccountHost: https://3scale-admin.example.com
  state: incomplete

3scale Operator가 새로운 3scale 리소스를 찾으면 LookupProviderAccount 프로세스는 리소스를 소유한 테넌트를 식별하기 위한 목적으로 시작됩니다.

이 프로세스는 테넌트 자격 증명 소스를 확인합니다. 찾을 수 없는 경우 오류가 발생합니다.

다음 단계에서는 프로세스가 테넌트 자격 증명 소스를 확인하는 방법을 설명합니다.

3scale 제품 엔터티를 관리하는 사용자 정의 리소스를 삭제하여 3scale 제품 엔터티를 삭제할 수 있습니다. 제품 사용자 정의 리소스를 삭제하면 3scale Operator는 삭제된 제품을 참조하는 오브젝트를 업데이트하지 않습니다.

3scale Operator를 설치한 후 DeveloperAccount 및 Developer User CR(사용자 정의 리소스)을 배포할 수 있습니다. 이러한 CR을 사용하면 개발자 포털에서 3scale-managed API에 액세스할 수 있도록 계정을 생성하고 업데이트할 수 있습니다.

새 DeveloperAccount CR을 배포하려면 admin 역할이 있는 사용자에 대해 DeveloperUser CR도 배포해야 합니다. 여기에서 제공되는 절차는 새 DeveloperAccount CR을 배포하는 것입니다. DeveloperAccount CR을 배포한 후 이를 업데이트하거나 삭제하는 절차는 다른 CR과 동일합니다.

3scale Operator가 포함된 네임스페이스에만 CR을 배포할 수 있습니다.

oc wait --for=condition=Ready --timeout=30s developeraccount/developeraccount1

실패하는 경우 사용자 정의 리소스의 상태 필드는 오류가 일시적이거나 영구적일지 여부를 나타내며 문제를 해결하는 데 도움이 되는 오류 메시지를 제공합니다.

새 개발자 사용자에게 개발자 포털에 로그인할 수 있음을 알립니다. 또한 로그인 자격 증명을 전달해야 할 수도 있습니다.

다른 사용자 정의 리소스를 업데이트하는 것과 동일한 방식으로 배포된 DeveloperAccount 사용자 정의 리소스를 업데이트할 수 있습니다. 예를 들어 업데이트할 DeveloperAccount CR을 보유한 테넌트가 포함된 OpenShift 프로젝트에서 다음 명령을 실행하여 devaccount1 CR을 업데이트합니다.

oc edit developeraccount devaccount1

3scale 운영자를 설치한 후에는 개발자 포털에서 3scale-managed API에 대한 개발자 액세스를 관리하기 위해 DeveloperUser CR(사용자 정의 리소스)을 배포할 수 있습니다. 여기에서 제공되는 절차는 새 DeveloperUser CR을 배포하는 것입니다. DeveloperUser CR을 배포한 후 업데이트하거나 삭제하는 절차는 다른 CR과 동일합니다.

3scale Operator가 포함된 네임스페이스에만 CR을 배포할 수 있습니다.

oc wait --for=condition=Ready --timeout=30s developeruser/developeruser02

실패하는 경우 사용자 정의 리소스의 상태 필드는 오류가 일시적이거나 영구적일지 여부를 나타내며 문제를 해결하는 데 도움이 되는 오류 메시지를 제공합니다.

새 개발자 사용자에게 개발자 포털에 로그인할 수 있음을 알립니다. 또한 로그인 자격 증명을 전달해야 할 수도 있습니다.

다른 사용자 정의 리소스를 업데이트하는 것과 동일한 방식으로 배포된 DeveloperUser 사용자 정의 리소스를 업데이트할 수 있습니다.

3scale 개발자 엔티티는 이를 관리하는 사용자 정의 리소스를 삭제하여 삭제할 수 있습니다. DeveloperAccount 사용자 정의 리소스를 삭제할 때 3scale Operator는 삭제된 DeveloperAccount CR에 연결된 모든 DeveloperUser CR도 삭제합니다.

백업할 수 있는 3scale 설치 구성을 보려면 다음 섹션을 참조하십시오.

다음 데이터베이스가 외부에서 구성되면 백업 기능을 사용할 수 있습니다.

다음 표는 백업된 데이터 목록을 보여줍니다.

기존 APIManager 와 함께 배포된 3scale 설치를 백업하려면 다음 단계를 사용합니다.

백업 내용은 Backed up data 에 자세히 설명되어 있습니다.

APIManagerBackup 의 status 섹션에 있는 다른 필드에는 구성된 백업 대상이 PVC일 때 데이터가 백업된 PVC 이름과 같은 백업 세부 정보가 표시됩니다.

향후 참조의 경우 status.backupPersistentVolumeClaimName 필드 값을 기록해 두십시오. APIManager Restore를 사용하여 APIManager 설치를 복원할 때 필요한 필드 중 하나는 PersistentVolumeClaimName 백업 소스입니다.

OpenShift 관리자 계정 외부에 CR 사본이 없는 경우 다음 명령을 사용하여 3scale 프로젝트 CR의 백업을 생성합니다.

복원할 수 있는 3scale 설치 구성을 보려면 다음 섹션을 참조하십시오.

3scale 운영자의 복원 기능은 APIManagerBackup 사용자 정의 리소스에서 생성된 백업을 사용하여 사용할 수 있습니다.

백업할 수 있는 3scale 솔루션 시나리오 목록은 Backed up data for reference를 참조하십시오.

다음은 Operator의 복원 기능 범위에 있지 않습니다.

다음 표는 복원된 데이터 목록을 보여줍니다.

APIManager Backup 사용자 정의 리소스를 사용하여 백업한 APIManager 를 사용하여 이전에 배포한 3scale 설치를 복원하려면 다음 단계를 따르십시오.

다음 섹션에서는 3scale과의 통합 초기 단계에서 APIcast 오류 로그에 표시되는 몇 가지 일반적인 문제를 개략적으로 설명합니다. APIcast Hosted를 사용하기 시작할 때 자체 관리 APIcast를 실행하기 전에 라이브로 실행할 수 있습니다.

설정을 완전히 테스트하고 잠시 API와 함께 실행한 후 API 게이트웨이에 문제가 발생하는 것은 드뭅니다. 그러나 실시간 프로덕션 환경에서 발생할 수 있는 몇 가지 문제는 다음과 같습니다.

upstream timed out (110: Connection timed out) while connecting to upstream, client: X.X.X.X, server: api.example.com, request: "GET /RESOURCE?CREDENTIALS HTTP/1.1", upstream: "http://Y.Y.Y.Y:80/RESOURCE?CREDENTIALS", host: "api.example.com"

새 엔드포인트 추가와 같은 API를 변경하는 경우 API 게이트웨이에 사용할 새 구성 파일 세트를 다운로드하기 전에 새 메서드 및 URL 매핑을 추가해야 합니다.

3scale에서 다운로드한 구성을 수정한 경우 가장 일반적인 문제는 Lua에서 코드 오류가 발생하여 다음과 같은 500 - 내부 서버 오류가 발생합니다.

curl -v -X GET "http://localhost/"
* About to connect() to localhost port 80 (#0)
*   Trying 127.0.0.1... connected
> GET / HTTP/1.1
> User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
> Host: localhost
> Accept: */*
>
< HTTP/1.1 500 Internal Server Error
< Server: openresty/1.5.12.1
< Date: Thu, 04 Feb 2016 10:22:25 GMT
< Content-Type: text/html
< Content-Length: 199
< Connection: close
<

<head><title>500 Internal Server Error</title></head>

<center><h1>500 Internal Server Error</h1></center>
<hr><center>openresty/1.5.12.1</center>


* Closing connection #0

다음과 같은 원인을 아는 nginx error.log를 볼 수 있습니다.

2016/02/04 11:22:25 [error] 8980#0: *1 lua entry thread aborted: runtime error: /home/pili/NGINX/troubleshooting/nginx.lua:66: bad argument #3 to '_newindex' (number expected, got nil)
stack traceback:
coroutine 0:
  [C]: in function '_newindex'
  /home/pili/NGINX/troubleshooting/nginx.lua:66: in function 'error_authorization_failed'
  /home/pili/NGINX/troubleshooting/nginx.lua:330: in function 'authrep'
  /home/pili/NGINX/troubleshooting/nginx.lua:283: in function 'authorize'
  /home/pili/NGINX/troubleshooting/nginx.lua:392: in function  while sending to client, client: 127.0.0.1, server: api-2445581381726.staging.apicast.io, request: "GET / HTTP/1.1", host: "localhost"

access.log에서 다음과 같이 표시됩니다.

127.0.0.1 - - [04/Feb/2016:11:22:25 +0100] "GET / HTTP/1.1" 500 199 "-" "curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3"

위의 섹션에서는 3scale 여행의 모든 단계에서 발생할 수 있는 가장 일반적인 잘 알려진 문제에 대한 개요를 제공합니다.

이러한 모든 사항이 확인되어 문제에 대한 원인과 해결 방법을 찾을 수 없는 경우 API 요청 문제 식별에 대한 자세한 섹션을 진행해야 합니다. API에서 시작하고 실패 지점을 식별하기 위해 클라이언트로 돌아가십시오.

telnet을 사용하여 기본 TCP/IP 연결 telnet api.example.com 443을 확인합니다.

telnet echo-api.3scale.net 80
Trying 52.21.167.109...
Connected to tf-lb-i2t5pgt2cfdnbdfh2c6qqoartm-829217110.us-east-1.elb.amazonaws.com.
Escape character is '^]'.
Connection closed by foreign host.

telnet su1.3scale.net 443
Trying 174.129.235.69...
telnet: Unable to connect to remote host: Connection timed out

다른 네트워크 위치, 장치 및 지침에서 동일한 서버에 연결을 시도합니다. 예를 들어 클라이언트가 API에 연결할 수 없는 경우 API 게이트웨이와 같이 액세스해야 하는 시스템에서 API에 연결해 봅니다.

시도한 커넥션 중 하나라도 성공적으로 수행되면 실제 서버의 문제를 배제하고 문제 해결을 위해 네트워크에 집중할 수 있습니다. 문제가 발생할 가능성이 가장 높기 때문입니다.

telnet apis.io 80 대신 호스트 이름(예: telnet 94.125.104.17 80 ) 대신 IP 주소를 사용하여 서버에 연결해 보십시오.

이렇게 하면 DNS에 문제가 없습니다.

예를 들어 3scale dig su1.3scale.net 의 경우 dig 를 사용하여 서버의 IP 주소를 가져오거나, 호스트가 확인할 수 있는 여러 개의 IP가 있다고 의심되는 경우 su1.3scale.net을 dig 로 분석할 수 있습니다.

NB: 일부 호스트는 'dig any'를 차단합니다.

OpenSSL을 사용하여 다음을 테스트할 수 있습니다.

CONNECTED(00000003)
140735196860496:error:14094410:SSL routines:ssl3_read_bytes:sslv3 alert handshake failure:s3_pkt.c:1456:SSL alert number 40
140735196860496:error:1409E0E5:SSL routines:ssl3_write_bytes:ssl handshake failure:s3_pkt.c:644:
---
no peer certificate available
---
No client certificate CA names sent
---
SSL handshake has read 7 bytes and written 0 bytes
---
New, (NONE), Cipher is (NONE)
Secure Renegotiation IS NOT supported
Compression: NONE
Expansion: NONE
No ALPN negotiated
SSL-Session:
    Protocol  : SSLv3
    Cipher    : 0000
    Session-ID:
    Session-ID-ctx:
    Master-Key:
    Key-Arg   : None
    PSK identity: None
    PSK identity hint: None
    SRP username: None
    Start Time: 1454932872
    Timeout   : 7200 (sec)
    Verify return code: 0 (ok)
---

자세한 내용은 OpenSSL 도움말 페이지를 참조하십시오.

API가 시작되어 요청에 응답하는지 확인하려면 API 게이트웨이를 통과하지 않음) API에 직접 동일한 요청을 수행합니다. API 게이트웨이를 통과하는 요청과 동일한 매개변수 및 헤더를 보내야 합니다. 오류가 발생한 정확한 요청이 확실하지 않은 경우 API 게이트웨이와 API 간의 트래픽을 캡처합니다.

호출이 성공하면 API에 대한 문제를 제외할 수 있습니다. 그렇지 않으면 API를 추가로 해결해야 합니다.

API 게이트웨이와 API 간의 네트워크 문제를 방지하려면 API 게이트웨이 서버와 동일한 호출을 수행합니다.

호출이 성공하면 API 게이트웨이 자체의 문제 해결으로 이동할 수 있습니다.

API 게이트웨이가 올바르게 작동하는지 확인하는 여러 단계가 있습니다.

API 게이트웨이가 올바르게 실행되고 있는지 확인한 후 다음 단계는 API 게이트웨이와 3scale 간 연결 문제를 해결하는 것입니다.

2015/11/20 11:33:51 [error] 3578#0: *1 upstream timed out (110: Connection timed out) while connecting to upstream, client: 127.0.0.1, server: , request: "GET /api/activities.json?user_key=USER_KEY HTTP/1.1", subrequest: "/threescale_authrep", upstream: "https://54.83.62.186:443/transactions/authrep.xml?provider_key=YOUR_PROVIDER_KEY&service_id=SERVICE_ID&usage[hits]=1&user_key=USER_KEY&log%5Bcode%5D=", host: "localhost"

http {
  lua_shared_dict api_keys 10m;
  server_names_hash_bucket_size 128;
  lua_package_path ";;$prefix/?.lua;";
  init_by_lua 'math.randomseed(ngx.time()) ; cjson = require("cjson")';

  resolver 8.8.8.8 8.8.4.4;

nslookup su1.3scale.net 8.8.8.8
;; connection timed out; no servers could be reached

2016/05/09 14:15:15 [alert] 9391#0: send() failed (1: Operation not permitted) while resolving, resolver: 8.8.8.8:53

body_filter_by_lua_block{
  if ngx.req.get_headers()["X-3scale-debug"] == ngx.var.provider_key then
    local resp = ""
    ngx.ctx.buffered = (ngx.ctx.buffered or "") .. string.sub(ngx.arg[1], 1, 1000)
    if ngx.arg[2] then
      resp = ngx.ctx.buffered
    end

    ngx.log(0, ngx.req.raw_header())
    ngx.log(0, resp)
  end
}

2016/05/05 14:24:33 [] 7238#0: *57 [lua] body_filter_by_lua:7: GET /api/contacts.json?access_token=7c6f24f5 HTTP/1.1
Host: 726e3b99.ngrok.io
User-Agent: curl/7.43.0
Accept: */*
X-Forwarded-Proto: https
X-Forwarded-For: 2.139.235.79

 while sending to client, client: 127.0.0.1, server: pili-virtualbox, request: "GET /api/contacts.json?access_token=7c6f24f5 HTTP/1.1", subrequest: "/threescale_authrep", upstream: "https://54.83.62.94:443/transactions/oauth_authrep.xml?provider_key=REDACTED&service_id=REDACTED&usage[hits]=1&access_token=7c6f24f5", host: "726e3b99.ngrok.io"
2016/05/05 14:24:33 [] 7238#0: *57 [lua] body_filter_by_lua:8: <?xml version="1.0" encoding="UTF-8"?><error code="access_token_invalid">access_token "7c6f24f5" is invalid: expired or never defined</error> while sending to client, client: 127.0.0.1, server: pili-virtualbox, request: "GET /api/contacts.json?access_token=7c6f24f5 HTTP/1.1", subrequest: "/threescale_authrep", upstream: "https://54.83.62.94:443/transactions/oauth_authrep.xml?provider_key=REDACTED&service_id=REDACTED&usage[hits]=1&access_token=7c6f24f5", host: "726e3b99.ngrok.io"

Swagger는 최신 버전의 swagger-ui를 통해 Swagger 사양 및 API를 테스트하는 데 사용할 수 있는 petstore.swagger.io에 호스팅된 swagger-ui를 제공합니다. swagger-ui와 ActiveDocs가 같은 방식으로 실패하는 경우 ActiveDocs 또는 ActiveDocs 프록시에 문제가 발생하지 않고 문제 해결에 중점을 둘 수 있습니다. 또는 swagger-ui의 현재 버전과 관련하여 알려진 문제가 있는지 swagger-ui GitHub 리포지토리를 확인할 수 있습니다.

API를 사용하는 클라이언트의 IP 주소를 허용 목록에 지정하지 않는 것이 좋습니다. ActiveDocs 프록시는 고가용성을 위해 유동 IP 주소를 사용하며 현재 이러한 IP에 대한 변경 사항을 알리는 메커니즘은 없습니다.

ActiveDocs 프록시가 올바르게 작동하는지 확인하는 한 가지 방법은 잘못된 인증 정보를 사용하여 API를 호출하는 것입니다. 이렇게 하면 ActiveDocs 프록시 및 API 게이트웨이 둘 다에 문제가 있는지 확인하거나 배제하는 데 도움이 됩니다.

API 호출에서 403 코드를 다시 가져오거나 잘못된 자격 증명을 위해 게이트웨이에 구성된 코드에서 가져온 경우 호출이 게이트웨이에 도달하므로 API에 문제가 있습니다.

ActiveDocs 외부와 ActiveDocs 외부에서 수행된 호출 간 헤더와 매개 변수의 차이점을 식별하려면 온프레미스 또는 Runscope와 같은 서비스를 통해 호출을 실행합니다. 이렇게 하면 HTTP 호출을 검사하고 비교한 후 API로 보낼 수 있습니다. 그러면 문제가 발생할 수 있는 요청에서 잠재적인 헤더 및/또는 매개 변수를 식별할 수 있습니다.

디버깅 로그 활성화에 대한 자세한 내용은 NGINX 디버깅 로그 설명서를 참조하십시오.