Skip to content

Documentation issue: unclear Atom signup flow when provisioning Propeller #256

Description

@IceManGreen

What were you trying to achieve?

Description

I started reading the documentation and experimenting with the Kubernetes deployment guide:

I noticed that the Getting Started guide appears to be slightly outdated (for example regarding make commands and propeller-cli usage), so I decided to follow the Kubernetes deployment guide instead since it seems more up to date.

I was able to complete the guide successfully up to step 4, but I am blocked on step 5, more specifically step 5.2: Provision the Propeller configuration.

Problem

When running:

propeller-cli provision -f docker/config.toml

the provisioning wizard asks for user credentials.
When I do it, it ends up with an error stating :

failed to create access token : Status: Unprocessable Entity: compare hash and password failed

According to the documentation, these credentials should come from an Atom user account. However, I could not find any instructions explaining how to create such an account.

The documentation states:

Log you into Atom (you must have an Atom user already created; if not, create one via Atom's API or signup flow)

Source:
https://www.absmach.eu/docs/propeller/getting-started/#step-3-provision-propeller

However, I was unable to find:

  • documentation for the Atom signup flow,
  • instructions for creating a user through Atom's API,
  • or any explanation of how Atom fits into the Propeller architecture.

Questions

  1. What credentials should be provided during the propeller-cli provision step?
  2. How should an Atom user be created when following the Kubernetes deployment guide?
  3. Is there a signup endpoint, UI, or API example available for creating users once Propeller is deployed using docker compose ?

What are the expected results?

I expect to use existing credentials and Atom accept those that I use to provision the configuration at step 5.2 of the documentation.

What are the received results?

failed to create access token : Status: Unprocessable Entity: compare hash and password failed

Steps To Reproduce

  1. From a fresh VM, follow this guide : https://www.absmach.eu/docs/propeller/k8s/example/
  2. Use the command at step 5.2
propeller-cli provision -f docker/config.toml

In what environment did you encounter the issue?

$ uname -a
Linux testbed-docker 6.1.0-17-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.69-1 (2023-12-30) x86_64 GNU/Linux
$ cat /etc/os-release 
PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"
NAME="Debian GNU/Linux"
VERSION_ID="12"
VERSION="12 (bookworm)"
VERSION_CODENAME=bookworm
ID=debian
$ docker --version
Docker version 29.6.1, build 8900f1d

Additional information you deem important

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workinghelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions