Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify the card/project configuration format & workflow #4

Closed
kelson42 opened this issue Jun 8, 2022 · 1 comment · Fixed by #12
Closed

Specify the card/project configuration format & workflow #4

kelson42 opened this issue Jun 8, 2022 · 1 comment · Fixed by #12
Assignees
@rgaudin @kelson42 @fheslouin
Labels
enhancement New feature or request question Further information is requested
Milestone
1.0.0

Comments

@kelson42
Copy link

kelson42 commented Jun 8, 2022

To configure the image creation process, a few things will have to be given. In a nutshell:

  • Meta information like for example: timezone, UI language, admin credentials, ...
  • Content: container images, containers, application configs & data (input+output)

I seems that JSON is the format which should be used to store this. So far we could reuse/rebase on:

The question of the naming has to be clarified as well:

  • Kiwix tends to use "card configuration"
  • OLIP tends to use "project configuration"

To provide such a configuration to the image creator we could use:

  • a fs path OR
  • an URL

Considering that this input will be generated by other softwares and that probably the content part will/should be reused in other parts of the toolchain, we should consider the reader/writer to better be generic IMO and proposed as a library.

Remark: obviously, things will evolved while the image-creator will be developed, but we still better have a pretty good agreement on the basics before we start.
@kelson42 kelson42 added enhancement New feature or request question Further information is requested labels Jun 8, 2022
@kelson42 kelson42 added this to the 1.0.0 milestone Jun 8, 2022
@kelson42
Copy link
Author

kelson42 commented Jun 8, 2022

See as well https://github.com/offspot/image-creator#json-configurator

rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
6ee69b6 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
7782160 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
2ac2e96 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
62e85ca 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
e48cc07 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
599ef34 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
c7c2efa 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
a06a500 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
55ee5f0 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
070bde0 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
a067ab4 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
efe49ad 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
98999b9 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
fa1de84 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted

TBC
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
a5bb08d 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted
@rgaudin rgaudin linked a pull request Dec 2, 2022 that will close this issue
Initial working version #12
Merged
@rgaudin rgaudin mentioned this issue Dec 2, 2022
Merged
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
74b8b70 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
1f477d2 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
84b9138 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted
rgaudin added a commit that referenced this issue Dec 2, 2022
@rgaudin
Initial working version
c794fff 
This is a working prototype that can be used to create working images from valid config files.

Fixes:
- Specify the card/project configuration format & workflow #4
- Implement Basic program structure #7
- Implement image file manipulation #10

Starts without completing:
- Implement Progress Reporting #8: text UI (cli) is done and usable. Machine-readable JSON file is not but can be implemented via the logger and StepMachine.
- Implement Downloader #9: a basic requests-based downloader is present. Needs more work to support transfer issues and being interupted
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rgaudin rgaudin

@kelson42 kelson42

@fheslouin fheslouin

Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

Initial working version offspot/image-creator
3 participants
@rgaudin @kelson42 @fheslouin