diff --git a/.dockerignore b/.dockerignore index 0a9ab50..7f0585c 100644 --- a/.dockerignore +++ b/.dockerignore @@ -10,5 +10,4 @@ CONTRIBUTING.md docker-compose.test.yml LICENSE Makefile -PULL_REQUEST_TEMPLATE.md README.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 3df4113..04b7aa2 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,3 +1,3 @@ # Default code owner -* @Senzing/senzing-community +* @senzing-garage/senzing-mechanics diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d3a80d7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] - -**Smartphone (please complete the following information):** - -- Device: [e.g. iPhone6] -- OS: [e.g. iOS8.1] -- Browser [e.g. stock browser, safari] -- Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation_request.md b/.github/ISSUE_TEMPLATE/documentation_request.md deleted file mode 100644 index c18a3fa..0000000 --- a/.github/ISSUE_TEMPLATE/documentation_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Documentation request -about: Identify an area for improvement in documentation - ---- - -**What is the URL of the documentation?** - -- **Example:** https://github.com/Senzing/template-docker#external-database - - *Note:* This URL includes the web page and the section of the documentation. - -**What can be improved?** - -A clear and concise description of what can be improved. -Examples: - -- "I don't understand where the ${XYZ} variable is set." -- "There seems to be a step missing between 'X' and 'Z'. I don't know how to get to 'Z'." -- "When I run `command sub-command ...` I get the following error:" -- "I don't know what is meant by 'gerble barb gazoink` in the instructions". - -**Additional context** - -Add any other context or screenshots to help describe the documentation improvement. -If you think the documentation improvement is operating system specific, -please indicate which operating system is being used. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 066b2d9..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/add-dependabot-request-to-project-t-comm.yaml b/.github/workflows/add-dependabot-request-to-project-t-comm.yaml deleted file mode 100644 index 4d24ae7..0000000 --- a/.github/workflows/add-dependabot-request-to-project-t-comm.yaml +++ /dev/null @@ -1,24 +0,0 @@ -# Based on -# - https://github.com/srggrs/assign-one-project-github-action - -name: add-dependabot-request-to-project-t-comm.yaml -on: - pull_request: - types: - - opened - - reopened -env: - GITHUB_TOKEN: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} - CREATOR: ${{ github.event.pull_request.user.login }} -jobs: - assign_one_project: - name: Add dependabot pull request to Senzing Community project - runs-on: ubuntu-latest - steps: - - name: Assign pull request to project - env: - BOOL: ${{ contains( env.CREATOR, 'dependabot' ) }} - uses: Senzing/github-action-add-issue-to-project@main - if: ${{ env.BOOL == 'true' }} - with: - project: 'https://github.com/orgs/Senzing/projects/2' diff --git a/.github/workflows/add-issue-to-project-t-comm.yaml b/.github/workflows/add-issue-to-project-t-comm.yaml deleted file mode 100644 index f2d32d7..0000000 --- a/.github/workflows/add-issue-to-project-t-comm.yaml +++ /dev/null @@ -1,21 +0,0 @@ -# Based on -# - https://github.com/srggrs/assign-one-project-github-action - -name: add-issue-to-project-t-comm.yaml -on: - issues: - types: - - reopened - - opened -env: - GITHUB_TOKEN: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} -jobs: - assign_one_project: - name: Add issue to Senzing Community project - runs-on: ubuntu-latest - steps: - - name: Assign issue to project - uses: Senzing/github-action-add-issue-to-project@main - with: - project: 'https://github.com/orgs/Senzing/projects/2' - column_name: 'Backlog' diff --git a/.github/workflows/identify-customer.yaml b/.github/workflows/add-label-customer-submission.yaml similarity index 72% rename from .github/workflows/identify-customer.yaml rename to .github/workflows/add-label-customer-submission.yaml index d8dcac2..f9dd8e8 100644 --- a/.github/workflows/identify-customer.yaml +++ b/.github/workflows/add-label-customer-submission.yaml @@ -1,18 +1,17 @@ -name: identify-customer.yaml +name: add-label-customer-submission.yaml on: issues: types: - opened env: - GITHUB_TOKEN: ${{ secrets.ORG_MEMBERSHIP_TOKEN }} MEMBER_LIST: ${{ secrets.SENZING_MEMBERS }} CREATOR: ${{ github.actor }} jobs: automate-issues-labels: - name: Add customer-submission label + name: Add customer-submission label to issue runs-on: ubuntu-latest steps: - - name: initial labeling + - name: Add customer-submission label env: BOOL: ${{ contains( env.MEMBER_LIST, env.CREATOR ) }} if: ${{ env.BOOL == 'false' }} diff --git a/.github/workflows/add-triage-label.yaml b/.github/workflows/add-label-triage.yaml similarity index 57% rename from .github/workflows/add-triage-label.yaml rename to .github/workflows/add-label-triage.yaml index 3153dde..fc32b8c 100644 --- a/.github/workflows/add-triage-label.yaml +++ b/.github/workflows/add-label-triage.yaml @@ -1,8 +1,4 @@ -# Based on -# - https://docs.github.com/en/actions/guides/adding-labels-to-issues -# - https://github.com/andymckay/labeler - -name: add-triage-label.yaml +name: add-label-triage.yaml on: issues: types: @@ -13,7 +9,7 @@ jobs: name: Add triage label to issue runs-on: ubuntu-latest steps: - - name: initial labeling + - name: Add triage label uses: andymckay/labeler@1.0.4 with: add-labels: "triage" diff --git a/.github/workflows/add-to-project-garage-dependabot.yaml b/.github/workflows/add-to-project-garage-dependabot.yaml new file mode 100644 index 0000000..91cb367 --- /dev/null +++ b/.github/workflows/add-to-project-garage-dependabot.yaml @@ -0,0 +1,21 @@ +name: add-to-project-garage-dependabot.yaml +on: + pull_request: + types: + - opened + - reopened +env: + CREATOR: ${{ github.event.pull_request.user.login }} +jobs: + add-to-project: + name: Add dependabot pull request to project + runs-on: ubuntu-latest + steps: + - name: Assign pull request to project + env: + BOOL: ${{ contains( env.CREATOR, 'dependabot' ) }} + if: ${{ env.BOOL == 'true' }} + uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/senzing-garage/projects/3 + github-token: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} diff --git a/.github/workflows/add-to-project-garage.yaml b/.github/workflows/add-to-project-garage.yaml new file mode 100644 index 0000000..4599e4e --- /dev/null +++ b/.github/workflows/add-to-project-garage.yaml @@ -0,0 +1,16 @@ +name: add-to-project-garage.yaml +on: + issues: + types: + - reopened + - opened +jobs: + add-to-project: + name: Add issue to project + runs-on: ubuntu-latest + steps: + - name: Assign issue to project + uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/senzing-garage/projects/3 + github-token: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }} diff --git a/.github/workflows/dependabot-approve-and-merge.yaml b/.github/workflows/dependabot-approve-and-merge.yaml new file mode 100644 index 0000000..a4574e4 --- /dev/null +++ b/.github/workflows/dependabot-approve-and-merge.yaml @@ -0,0 +1,12 @@ +name: dependabot-approve-and-merge.yaml +on: + pull_request: + branches: [main] +jobs: + dependabot-approve-and-merge: + permissions: + contents: write + pull-requests: write + uses: Senzing/build-resources/.github/workflows/dependabot-approve-and-merge.yaml@main + secrets: + SENZING_GITHUB_CODEOWNER_PR_RW_TOKEN: ${{ secrets.SENZING_GITHUB_CODEOWNER_PR_RW_TOKEN }} diff --git a/.github/workflows/docker-build-container.yaml b/.github/workflows/docker-build-container.yaml new file mode 100644 index 0000000..ba76706 --- /dev/null +++ b/.github/workflows/docker-build-container.yaml @@ -0,0 +1,16 @@ +name: docker-build-container.yaml +on: + pull_request: + branches: + - main + workflow_dispatch: +jobs: + docker-build-container: + runs-on: ubuntu-latest + steps: + - name: Build docker image + uses: Senzing/github-action-docker-buildx-build@latest + with: + image-repository: senzing/test-ground + password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }} + username: ${{ secrets.DOCKERHUB_USERNAME }} diff --git a/.github/workflows/move-pr-to-done.yaml b/.github/workflows/move-pr-to-done.yaml new file mode 100644 index 0000000..57fde8e --- /dev/null +++ b/.github/workflows/move-pr-to-done.yaml @@ -0,0 +1,9 @@ +name: move-pr-to-done.yaml +on: + pull_request: + types: [closed] +jobs: + move-pr-to-done: + uses: Senzing/build-resources/.github/workflows/move-pr-to-done.yaml@main + secrets: + SENZING_GITHUB_PROJECT_RW_TOKEN: ${{ secrets.SENZING_GITHUB_PROJECT_RW_TOKEN }} diff --git a/.github/workflows/pylint.yaml b/.github/workflows/pylint.yaml index 604eba8..df61166 100644 --- a/.github/workflows/pylint.yaml +++ b/.github/workflows/pylint.yaml @@ -3,21 +3,21 @@ name: pylint.yaml on: [push] jobs: - build: + pylint: runs-on: ubuntu-latest strategy: matrix: python-version: ["3.8", "3.9", "3.10"] steps: - - uses: actions/checkout@v4 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install pylint - - name: Analysing the code with pylint - run: | - pylint $(git ls-files '*.py') + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pylint + - name: Analysing the code with pylint + run: | + pylint $(git ls-files '*.py') diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f6f9f91..a8f1a17 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@senzing.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f6390d..66b445b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,7 @@ These variables may be modified, but do not need to be modified. The variables are used throughout the installation procedure. ```console -export GIT_ACCOUNT=senzing +export GIT_ACCOUNT=senzing-garage export GIT_REPOSITORY=keystore-generator ``` diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0b11a2f..0000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,13 +0,0 @@ -# Pull request questions - -## Which issue does this address - -Issue number: #nnn - -## Why was change needed - -??? - -## What does change improve - -??? diff --git a/README.md b/README.md index 4cd5439..9644973 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ # keystore-generator +If you are beginning your journey with +[Senzing](https://senzing.com/), +please start with +[Senzing Quick Start guides](https://docs.senzing.com/quickstart/). + +You are in the +[Senzing Garage](https://github.com/senzing-garage) +where projects are "tinkered" on. +Although this GitHub repository may help you understand an approach to using Senzing, +it's not considered to be "production ready" and is not considered to be part of the Senzing product. +Heck, it may not even be appropriate for your application of Senzing! + ## Synopsis -Generates a client and server java keystore that is used to provide client SSL authentication for [Senzing API Server](https://github.com/Senzing/senzing-api-server) and [Senzing POC Server](https://github.com/Senzing/senzing-poc-server). +Generates a client and server java keystore that is used to provide client SSL authentication for [Senzing API Server](https://github.com/senzing-garage/senzing-api-server) and [Senzing POC Server](https://github.com/senzing-garage/senzing-poc-server). ## Overview @@ -16,7 +28,7 @@ To see all of the subcommands, run: $ ./keystore-generator.py usage: keystore-generator.py [-h] {aws,sleep,version,docker-acceptance-test} ... -Initialize Senzing installation. For more information, see https://github.com/Senzing/keystore-generator +Initialize Senzing installation. For more information, see https://github.com/senzing-garage/keystore-generator positional arguments: {aws,sleep,version,docker-acceptance-test} Subcommands (SENZING_SUBCOMMAND): @@ -45,12 +57,12 @@ optional arguments: At [Senzing](http://senzing.com), we strive to create GitHub documentation in a -"[don't make me think](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/dont-make-me-think.md)" style. +"[don't make me think](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/dont-make-me-think.md)" style. For the most part, instructions are copy and paste. Whenever thinking is needed, it's marked with a "thinking" icon :thinking:. Whenever customization is needed, it's marked with a "pencil" icon :pencil2:. If the instructions are not clear, please let us know by opening a new -[Documentation issue](https://github.com/Senzing/keystore-generator/issues/new?template=documentation_request.md) +[Documentation issue](https://github.com/senzing-garage/keystore-generator/issues/new?template=documentation_request.md) describing where we can improve. Now on with the show... ### Legend @@ -61,12 +73,12 @@ describing where we can improve. Now on with the show... 1. :pencil2: - A "pencil" icon means that the instructions may need modification before performing. 1. :warning: - A "warning" icon means that something tricky is happening, so pay attention. -## Expectations +### Expectations - **Space:** This repository and demonstration require 6 GB free disk space. - **Time:** Budget 15 minutes to get the demonstration up-and-running, depending on CPU and network speeds. - **Background knowledge:** This repository assumes a working knowledge of: - - [Docker](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/docker.md) + - [Docker](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/docker.md) ## Demonstrate using Docker @@ -97,10 +109,10 @@ describing where we can improve. Now on with the show... ``` 1. :warning: - **macOS** - [File sharing](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#macos) + **macOS** - [File sharing](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#macos) must be enabled for `SENZING_VOLUME`. 1. :warning: - **Windows** - [File sharing](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#windows) + **Windows** - [File sharing](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/share-directories-with-docker.md#windows) must be enabled for `SENZING_VOLUME`. 1. Set environment variables. @@ -161,9 +173,9 @@ describing where we can improve. Now on with the show... Configuration values specified by environment variable or command line parameter. -- **[SENZING_DATABASE_URL](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_database_url)** -- **[SENZING_DEBUG](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_debug)** -- **[SENZING_ENGINE_CONFIGURATION_JSON](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md#senzing_engine-configuration_json)** +- **[SENZING_DATABASE_URL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_database_url)** +- **[SENZING_DEBUG](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_debug)** +- **[SENZING_ENGINE_CONFIGURATION_JSON](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_engine-configuration_json)** ## License @@ -173,7 +185,7 @@ for the software container in this Docker image. Note that this license does not permit further distribution. This Docker image may also contain software from the -[Senzing GitHub community](https://github.com/Senzing/) +[Senzing GitHub community](https://github.com/senzing-garage/) under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). @@ -193,4 +205,4 @@ with any relevant licenses for all software contained within. 1. [Examples](docs/examples.md) 1. Related artifacts: 1. [DockerHub](https://hub.docker.com/r/senzing/keystore-generator) - 1. [Helm Chart](https://github.com/Senzing/charts/tree/main/charts/senzing-keystore-generator) + 1. [Helm Chart](https://github.com/senzing-garage/charts/tree/main/charts/senzing-keystore-generator) diff --git a/docs/development.md b/docs/development.md index 1216185..bc6b3fc 100644 --- a/docs/development.md +++ b/docs/development.md @@ -8,14 +8,14 @@ The following instructions are used when modifying and building the Docker image These are "one-time tasks" which may already have been completed. 1. The following software programs need to be installed: - 1. [git](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/git.md) - 1. [make](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/make.md) - 1. [docker](https://github.com/Senzing/knowledge-base/blob/main/WHATIS/docker.md) + 1. [git](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/git.md) + 1. [make](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/make.md) + 1. [docker](https://github.com/senzing-garage/knowledge-base/blob/main/WHATIS/docker.md) ## Clone repository For more information on environment variables, -see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/lists/environment-variables.md). +see [Environment Variables](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md). 1. Set these environment variable values: @@ -26,7 +26,7 @@ see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/ export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" ``` -1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/Senzing/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository. +1. Using the environment variables values just set, follow steps in [clone-repository](https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/clone-repository.md) to install the Git repository. ## Build Docker image @@ -35,7 +35,7 @@ see [Environment Variables](https://github.com/Senzing/knowledge-base/blob/main/ ```console sudo docker build \ --tag senzing/keystore-generator \ - https://github.com/senzing/keystore-generator.git#main + https://github.com/senzing-garage/keystore-generator.git#main ``` 1. **Option #2:** Using `docker` command and local repository. diff --git a/keystore-generator.py b/keystore-generator.py index d9aef80..5c70e4b 100755 --- a/keystore-generator.py +++ b/keystore-generator.py @@ -30,7 +30,7 @@ __date__ = '2022-09-01' __updated__ = '2022-09-01' -SENZING_PRODUCT_ID = "5032" # See https://github.com/Senzing/knowledge-base/blob/main/lists/senzing-product-ids.md +SENZING_PRODUCT_ID = "5032" # See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-product-ids.md LOG_FORMAT = '%(asctime)s %(message)s' # The "configuration_locator" describes where configuration variables are in: @@ -135,7 +135,7 @@ def get_parser(): # Parse command line arguments. - parser = argparse.ArgumentParser(prog="keystore-generator.py", description="Initialize Senzing installation. For more information, see https://github.com/Senzing/keystore-generator") + parser = argparse.ArgumentParser(prog="keystore-generator.py", description="Initialize Senzing installation. For more information, see https://github.com/senzing-garage/keystore-generator") subparsers = parser.add_subparsers(dest='subcommand', help='Subcommands (SENZING_SUBCOMMAND):') for subcommand_key, subcommand_values in subcommands.items(): @@ -166,7 +166,7 @@ def get_parser(): MESSAGE_DICTIONARY = { "100": "senzing-" + SENZING_PRODUCT_ID + "{0:04d}I", "157": "{0} - Creating file", - "293": "For information on warnings and errors, see https://github.com/Senzing/keystore-generator#errors", + "293": "For information on warnings and errors, see https://github.com/senzing-garage/keystore-generator#errors", "294": "Version: {0} Updated: {1}", "295": "Sleeping infinitely.", "296": "Sleeping {0} seconds.", diff --git a/requirements.txt b/requirements.txt index 30ddf82..18fa40e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1 @@ -boto3 +boto3==1.34.7